Browse Source

change SVG Sprites for icon doc

杜府 3 years ago
parent
commit
cd68646c6d

+ 1 - 1
components/package.json

@@ -1,6 +1,6 @@
 {
     "name": "stdf",
-    "version": "0.0.3",
+    "version": "0.0.4",
     "description": "Mobile Web component library based on Svelte and Tailwind",
     "main": "index.js",
     "scripts": {

+ 1 - 1
components/src/icon/api.md

@@ -2,7 +2,7 @@
 
 | 属性       | 类型          | 默认值              | 可选值        | 必传  | 说明                             |
 |----------|-------------|------------------|------------|-----|--------------------------------|
-| name     | String/slot | ''               | Remix/slot | Y   | 图标名称。                          |
+| name     | String/slot | ''               | SVG Sprites name/slot | Y   | 图标名称。                          |
 | size     | Number      | 24               | -          | N   | 图标大小。                          |
 | theme    | Boolean     | false            | true/false | N   | 是否跟随主题色(包含亮色与暗色)。              |
 | alpha    | Number      | 1                | 0 - 1      | N   | 图标透明度。                         |

+ 1 - 1
components/src/icon/api_en.md

@@ -2,7 +2,7 @@
 
 | Properties | Type        | Default value              | Optional value | required | Description                                                           |
 | ---------- | ----------- | -------------------------- | -------------- | -------- | --------------------------------------------------------------------- |
-| name       | String/slot | ''                         | Remix/slot     | Y        | Icon name.                                                            |
+| name       | String/slot | ''                         | SVG Sprites name/slot     | Y        | Icon name.                                                            |
 | size       | Number      | 24                         | -              | N        | Icon size.                                                            |
 | theme      | Boolean     | false                      | true/false     | N        | Whether to follow the theme color (including bright and dark colors). |
 | alpha      | Number      | 1                          | 0 - 1          | N        | Icon transparency.                                                    |

+ 1 - 1
components/src/toast/api.md

@@ -13,7 +13,7 @@
 | transitionParams | Object  | {}       | 参考 [svelte/transition](https://svelte.dev/docs#run-time-svelte-transition) | N    | 动画参数,其中 duration 默认 300。                                    |     |
 | outDuration      | Number  | 0        | -                                                                            | N    | 退出动画时间,单位:ms。                                              |     |
 | mask             | Object  | {}       | 参考 Mask Props                                                              | N    | 遮罩层参数。                                                          |     |
-| type             | String  | ''       | ''/'success'/'error'/'warning'/'info'/'loading'/Remix name                   | N    | 提示类型。                                                            |     |
+| type             | String  | ''       | ''/'success'/'error'/'warning'/'info'/'loading'/SVG Sprites name                   | N    | 提示类型。                                                            |     |
 | loading          | Object  | {}       | 参考 Loading Props                                                           | N    | 加载组件参数,仅 type 为 'loading' 时生效。                           |     |
 | icon             | Object  | {}       | 参考 Icon Props                                                              | N    | 图标组件参数,type 非 '' 且非 'loading' 时生效。                      |     |
 | zIndex           | Number  | 1000     | -                                                                            | N    | z-index。                                                             |

+ 1 - 1
components/src/toast/api_en.md

@@ -13,7 +13,7 @@
 | transitionParams | Object  | {}       | See [svelte/transition](https://svelte.dev/docs#run-time-svelte-transition) | N        | Animation parameters, with the default duration set to 300ms.                                                                                           |
 | outDuration      | Number  | 0        | -                                                                           | N        | Duration of the exit animation in milliseconds.                                                                                                         |
 | mask             | Object  | {}       | See Mask Props                                                              | N        | Parameters for the mask layer.                                                                                                                          |
-| type             | String  | ''       | ''/'success'/'error'/'warning'/'info'/'loading'/Remix name                  | N        | Type of notification.                                                                                                                                   |
+| type             | String  | ''       | ''/'success'/'error'/'warning'/'info'/'loading'/SVG Sprites name                  | N        | Type of notification.                                                                                                                                   |
 | loading          | Object  | {}       | See Loading Props                                                           | N        | Parameters for the loading component, only effective when the type is 'loading'.                                                                        |
 | icon             | Object  | {}       | See Icon Props                                                              | N        | Parameters for the icon component, only effective when the type is non-empty and non-'loading'.                                                         |
 | zIndex           | Number  | 1000     | -                                                                           | N        | z-index.                                                                                                                                                |

+ 1 - 1
components/src/toast/guide.md

@@ -20,7 +20,7 @@ transitionParams 具体支持的参数请参考 [svelte/transition](https://svel
 
 ## type
 
-Toast 内部默认为 'success'/'error'/'warning'/'info'/'loading' 五种情况设置了对应的内容,也可以通过 `type` 属性自定义,传 '' 不显示,传入其他 Remix Icon 名称显示对应的 Icon,请参考示例。
+Toast 内部默认为 'success'/'error'/'warning'/'info'/'loading' 五种情况设置了对应的内容,也可以通过 `type` 属性自定义,传 '' 不显示,传入其他 SVG Sprites 名称显示对应的 Icon,请参考示例。
 
 ## useSlot
 

+ 1 - 1
components/src/toast/guide_en.md

@@ -18,7 +18,7 @@ Note: Because the toast has an animation duration (default 300ms or another cust
 
 ## Type
 
-By default, the toast has predefined content for five types: 'success', 'error', 'warning', 'info' and 'loading'. You can also customize the content by setting the `type` property. If `type` is set to an empty string, no icon will be displayed. Otherwise, the icon corresponding to the name of the Remix Icon passed to the `type` property will be displayed.
+By default, the toast has predefined content for five types: 'success', 'error', 'warning', 'info' and 'loading'. You can also customize the content by setting the `type` property. If `type` is set to an empty string, no icon will be displayed. Otherwise, the icon corresponding to the name of the SVG Sprites Icon passed to the `type` property will be displayed.
 
 ## Use Slot
 

+ 2 - 2
package.json

@@ -1,12 +1,12 @@
 {
 	"name": "stdf",
-	"version": "0.0.3",
+	"version": "0.0.4",
 	"description": "Mobile Web component library based on Svelte and Tailwind",
 	"main": "index.js",
 	"scripts": {
 		"test": "echo \"Error: no test specified\" && exit 1",
 		"cpREADME": "cp README.md ./components",
-		"updateV": "node updatedV.js",
+		"updateV": "node updateV.js",
 		"publish": "cd components && npm publish",
 		"preGit": "npm run cpREADME && npm run updateV && npm run publish"
 	},

+ 0 - 0
updatedV.js → updateV.js