Skip to content

Commit

Permalink
* utilities: update docs for effects helpers.
Browse files Browse the repository at this point in the history
  • Loading branch information
catouse committed Dec 16, 2023
1 parent a225b61 commit 9fe90a3
Show file tree
Hide file tree
Showing 9 changed files with 339 additions and 199 deletions.
52 changes: 25 additions & 27 deletions lib/utilities/docs/utilities/effects/animation.md
Original file line number Diff line number Diff line change
@@ -1,57 +1,55 @@
# 动画

## 效果展示
## 旋转

### 旋转

使用`spin`给元素添加旋转动画
使用 `animate-spin` 给元素添加旋转动画效果。

<Example>
<button type="button" class="btn primary">
<i class="spin icon icon-spinner-indicator text-white"></i> 旋转
<i class="animate-spin icon icon-spinner-indicator"></i> 加载中
</button>
</Example>

```html
<button type="button" class="btn primary">
<i class="spin icon icon-spinner-indicator text-white"></i> 旋转
<i class="animate-spin icon icon-spinner-indicator"></i> 加载中
</button>
```

### 水波纹
## 水波纹

使用`ping`给元素添加水波纹动画
使用 `animate-ping` 给元素添加水波纹动画

<Example>
<button type="button" class="btn primary">
<i class="ping icon icon-thumbs-up text-white"></i> 水波纹
<i class="animate-ping icon icon-thumbs-up"></i> 赞!
</button>
</Example>

```html
<button type="button" class="btn primary">
<i class="ping icon icon-thumbs-up text-white"></i> 水波纹
<i class="animate-ping icon icon-thumbs-up"></i> 赞!
</button>
```

### 脉冲
## 脉冲

使用`pulse`给元素添加脉冲动画
使用 `animate-pulse` 给元素添加脉冲动画

<Example>
<div class="pulse rounded w-full max-auto flex px-4 py-4">
<div class="w-16 h-16 bg-primary circle">
</div>
<div class="flex-1 h-16 px-4 ">
<div class="h-4 w-48 bg-primary mb-2 rounded"></div>
<div class="h-4 w-96 bg-primary mb-2 rounded"></div>
<div class="h-4 flex-1 bg-primary rounded"></div>
</div>
<div class="animate-pulse rounded w-full max-auto flex px-4 py-4">
<div class="w-16 h-16 bg-primary circle">
</div>
<div class="flex-1 h-16 px-4 ">
<div class="h-4 w-48 bg-primary mb-2 rounded"></div>
<div class="h-4 w-96 bg-primary mb-2 rounded"></div>
<div class="h-4 flex-1 bg-primary rounded"></div>
</div>
</div>
</Example>

```html
<div class="pulse rounded w-full max-auto flex px-4 py-4">
<div class="animate-pulse rounded w-full max-auto flex px-4 py-4">
<div class="w-16 h-16 bg-primary circle">
</div>
<div class="flex-1 h-16 px-4 ">
Expand All @@ -62,18 +60,18 @@
</div>
```

### 弹跳
## 弹跳

使用`bounce`给元素添加弹跳动画
使用 `animate-bounce` 给元素添加弹跳动画

<Example>
<button type="button" class="btn primary">
<i class="bounce icon icon-arrow-down text-white"></i> 弹跳
</button>
<button type="button" class="btn primary">
<i class="bounce icon icon-arrow-down"></i> 下载
</button>
</Example>

```html
<button type="button" class="btn primary">
<i class="bounce icon icon-arrow-down text-white"></i> 弹跳
<i class="bounce icon icon-arrow-down"></i> 下载
</button>
```
186 changes: 103 additions & 83 deletions lib/utilities/docs/utilities/effects/filter.md
Original file line number Diff line number Diff line change
@@ -1,103 +1,123 @@
# Filter函数

## 效果展示

### 高斯模糊

通过`blur-*`给图片添加高斯模糊样式。

<Example class="flex flex-wrap gap-3">
<div v-for="item in blurJson">
<img src="/favicon.svg" :class="item.includes('原始') ? '' : item" class="w-16 h-16">
<div class="text-center">{{item}}</div>
# CSS 滤镜

## 高斯模糊

通过 `blur-*` 给图片添加高斯模糊样式。

<Example class="flex flex-wrap gap-6 p-6">
<div v-for="item in blurList" :key="item">
<StyleTile
:tileClass="['w-16 h-16', item]"
:name="item"
:labelClass="['text-center', item ? 'font-mono text-sm' : '']"
:label="item || '原始'"
>
<img src="/favicon.svg">
</StyleTile>
</div>
</Example>

### 灰度和反色
## 灰度和反色

通过`grascale`将图像转为灰度图像;通过`invert`将图像设置为反色。
通过 `grayscale` 将图像转为灰度图像;通过 `invert` 将图像设置为反色。

<Example class="flex flex-wrap gap-3">
<div v-for = "item in grasJson">
<img src="/favicon.svg" :class="item.includes('原始') ? '' : item" class="w-16 h-16">
<div class="text-center">{{item}}</div>
<Example class="flex flex-wrap gap-6 p-6">
<div v-for="item in grayList" :key="item">
<StyleTile
:tileClass="['w-16 h-16', item]"
:name="item"
:labelClass="['text-center', item ? 'font-mono text-sm' : '']"
:label="item || '原始'"
>
<img src="/favicon.svg">
</StyleTile>
</div>
</Example>

## 形状阴影

通过 `drop-shadow-*` 给元素设置形状阴影效果,通常用在图片上。

### 图像阴影

通过`dsd-*`给图像设置阴影效果。

<Example class="flex flex-wrap gap-3">
<div v-for = "item in dsdJson">
<img src="/favicon.svg" :class="item.includes('原始') ? '' : item" class="w-16 h-16">
<div class="text-center mt-2">{{item}}</div>
<Example class="flex flex-wrap gap-6 p-6">
<div v-for="item in dropShadowList" :key="item">
<StyleTile
:tileClass="['w-32 h-16', item]"
:name="item"
:labelClass="['text-center', item ? 'font-mono text-sm' : '']"
:label="item || '原始'"
>
<img :class="['w-16', item]" src="/favicon.svg">
</StyleTile>
</div>
</Example>

```html
<img class="dsd-sm" ... >
```
## 背景模糊

通过 `backdrop-blur-*` 添加覆盖区域模糊样式。

<Example class="flex flex-wrap gap-6 p-6">
<div v-for="item in bgBlurList" :key="item">
<StyleTile
:tileClass="['w-32 h-32 bg-contain', item]"
:name="item"
:labelClass="['text-center', item ? 'font-mono text-sm' : '']"
:label="item || '原始'"
:tileStyle="{backgroundImage: 'url(/favicon.svg)'}"
>
<div :class="['w-16 h-16 bg-white bg-opacity-30', item]"></div>
</StyleTile>
</div>
</Example>

### 覆盖区域模糊
## 禁用滤镜

通过`bg-blur-*`添加覆盖区域模糊样式
通过 `filter-none` 来禁用之前添加的滤镜效果

<Example class="flex flex-wrap gap-3 w-full h-full">
<div v-for = "item in bgBlurJson" class="relative w-24 h-24">
<img src="/favicon.svg" class="w-full h-16 absolute">
<div :class="item.includes('原始') ? '' : item" class="z-10 w-full h-16 absolute bg-transparent">
<div class="text-center -text-2xl text-canvas mt-4">ZUI3</div>
</div>
<div class="text-center z-10 w-full h-6 absolute bottom-0">{{item}}</div>
</div>
<Example class="flex flex-wrap gap-6 p-6">
<StyleTile
:tileClass="['w-16 h-16', 'filter-none']"
:name="'filter-none'"
:labelClass="['text-center', 'filter-none' ? 'font-mono text-sm' : '']"
:label="'filter-none' || '原始'"
>
<img src="/favicon.svg">
</StyleTile>
</Example>
```html
<div class="relative w-24 h-16">
<img class="absolute w-full h-full src=..." >
<div class="absolute w-full h-full bg-blur-sm">
ZUI3
</div>
</div>
```

<script setup>
const blurJson = [
'原始',
'blur-none',
'blur-sm',
'blur',
'blur-md',
'blur-lg',
'blur-xl',
];
const grasJson = [
'原始',
'grayscale',
'invert'
];
const dsdJson = [
'原始',
'dsd-none',
'dsd-sm',
'dsd',
'dsd-md',
'dsd-lg',
'dsd-xl',
'dsd-2xl',
];
const bgBlurJson = [
'原始',
'bg-blur-none',
'bg-blur-sm',
'bg-blur',
'bg-blur-md',
'bg-blur-lg',
'bg-blur-xl',
'bg-blur-2xl',
'bg-blur-3xl',
]
const blurList = [
'',
'blur-none',
'blur-sm',
'blur',
'blur-md',
'blur-lg',
'blur-xl',
];
const grayList = [
'',
'grayscale',
'invert'
];
const dropShadowList = [
'',
'drop-shadow-none',
'drop-shadow-sm',
'drop-shadow',
'drop-shadow-md',
'drop-shadow-lg',
'drop-shadow-xl',
'drop-shadow-2xl',
];
const bgBlurList = [
'',
'backdrop-blur-none',
'backdrop-blur-sm',
'backdrop-blur',
'backdrop-blur-md',
'backdrop-blur-lg',
'backdrop-blur-xl',
'backdrop-blur-2xl',
'backdrop-blur-3xl',
];
</script>
20 changes: 0 additions & 20 deletions lib/utilities/docs/utilities/effects/flip.md

This file was deleted.

22 changes: 13 additions & 9 deletions lib/utilities/docs/utilities/effects/opacity.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,23 @@
# 不透明度
# 透明度

使用`opacity-*`设置元素的不透明度
使用 `opacity-*` 设置元素的透明度。

<Example background="light-grid">
<div class="-grid -grid-cols-4 -gap-3">
<div :key="item" v-for ="item in opacityJson">
<div :class="item" class="bg-primary h-10" ></div>
<div class="text-center">{{item}}</div>
</div>
<Example class="flex flex-wrap gap-8 p-8">
<div v-for="item in opacityList" :key="item">
<StyleTile
:tileClass="['w-16 h-16', item]"
:name="item"
:labelClass="['text-center', item ? 'font-mono text-sm' : '']"
:label="item || '原始'"
>
<img src="/favicon.svg">
</StyleTile>
</div>
</Example>


<script setup>
const opacityJson = [
const opacityList = [
'opacity-0',
'opacity-5',
'opacity-10',
Expand Down
26 changes: 0 additions & 26 deletions lib/utilities/docs/utilities/effects/rotate.md

This file was deleted.

Loading

0 comments on commit 9fe90a3

Please sign in to comment.