@antsoo-lib/components 0.1.2 → 0.1.4

package/src/grid/index.en-US.md

@@ -0,0 +1,67 @@
+---
+category: Components
+type: Layout
+cols: 1
+title: Grid
+cover: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*mfJeS6cqZrEAAAAAAAAAAAAADrJ8AQ/original
+coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*DLUwQ4B2_zQAAAAAAAAAAAAADrJ8AQ/original
+---
+
+24 Grids System.
+
+## Design concept
+
+<div class="grid-demo">
+  <img src="https://gw.alipayobjects.com/zos/bmw-prod/9189c9ef-c601-40dc-9960-c11dbb681888.svg" alt="grid design" />
+</div>
+
+In most business situations, Ant Design Vue needs to solve a lot of information storage problems within the design area, so based on 12 Grids System, we divided the design area into 24 sections.
+
+We name the divided area 'box'. We suggest four boxes for horizontal arrangement at most, one at least. Boxes are proportional to the entire screen as shown in the picture above. To ensure a high level of visual comfort, we customize the typography inside of the box based on the box unit.
+
+## Outline
+
+In the grid system, we define the frame outside the information area based on \`row\` and \`column\`, to ensure that every area can have stable arrangement.
+
+Following is a brief look at how it works:
+
+- Establish a set of \`column\` in the horizontal space defined by \`row\` (abbreviated col)
+- Your content elements should be placed directly in the \`col\`, and only \`col\` should be placed directly in \`row\`
+- The column grid system is a value of 1-24 to represent its range spans. For example, three columns of equal width can be created by \`<a-col :span="8" />\`.
+- If the sum of \`col\` spans in a \`row\` are more than 24, then the overflowing \`col\` as a whole will start a new line arrangement.
+
+## Flex layout
+
+Our grid systems support Flex layout to allow the elements within the parent to be aligned horizontally - left, center, right, wide arrangement, and decentralized arrangement. The Grid system also supports vertical alignment - top aligned, vertically centered, bottom-aligned. You can also define the order of elements by using \`order\`. Flex layout uses a 24 grid layout to define the width of each "box", but does not rigidly adhere to the grid layout.
+
+## API
+
+### Row
+
+| Property | Description                                                                                                                                                                                                                 | Type                                                                                                  | Default | Version |
+| -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ------- | ------- | ---- | ---- | --------------- | -------- | -------- | -------------- | --------------- | ---------------- | ------- | ----------- |
+| align    | Vertical alignment                                                                                                                                                                                                          | `top` \| `middle` \| `bottom` \| `stretch` \| `{[key in 'xs'                                          | 'sm'    | 'md'    | 'lg' | 'xl' | 'xxl']: 'top'   | 'middle' | 'bottom' | 'stretch'}`    | `top`           | object: 4.0      |
+| gutter   | Spacing between grids, could be a number or a object like `{ xs: 8, sm: 16, md: 24}`. or you can use array to make horizontal and vertical spacing work at the same time `[horizontal, vertical]` (supported after `1.5.0`) | number/object/array                                                                                   | 0       | -       |
+| justify  | Horizontal arrangement                                                                                                                                                                                                      | `start` \| `end` \| `center` \| `space-around` \| `space-between` \| `space-evenly` \| `{[key in 'xs' | 'sm'    | 'md'    | 'lg' | 'xl' | 'xxl']: 'start' | 'end'    | 'center' | 'space-around' | 'space-between' | 'space-evenly'}` | `start` | object: 4.0 |
+| wrap     | Auto wrap line                                                                                                                                                                                                              | boolean                                                                                               | false   | -       |
+
+### Col
+
+| Property | Description                                                                                    | Type           | Default | Version |
+| -------- | ---------------------------------------------------------------------------------------------- | -------------- | ------- | ------- |
+| flex     | the layout fill of flex                                                                        | string\|number | -       |
+| offset   | the number of cells to offset Col from the left                                                | number         | 0       |
+| order    | raster order, used in `flex` layout mode                                                       | number         | 0       |
+| pull     | the number of cells that raster is moved to the left                                           | number         | 0       |
+| push     | the number of cells that raster is moved to the right                                          | number         | 0       |
+| span     | raster number of cells to occupy, 0 corresponds to `display: none`                             | number         | none    |
+| xs       | `<576px` and also default setting, could be a `span` value or an object containing above props | number\|object | -       |
+| sm       | `≥576px`, could be a `span` value or an object containing above props                          | number\|object | -       |
+| md       | `≥768px`, could be a `span` value or an object containing above props                          | number\|object | -       |
+| lg       | `≥992px`, could be a `span` value or an object containing above props                          | number\|object | -       |
+| xl       | `≥1200px`, could be a `span` value or an object containing above props                         | number\|object | -       |
+| xxl      | `≥1600px`, could be a `span` value or an object containing above props                         | number\|object | -       |
+
+You can modify the breakpoints values using by modifying `screen[XS|SM|MD|LG|XL|XXL]` with [theme customization](/docs/vue/customize-theme) (since 4.0.0, [sandbox demo](https://codesandbox.io/s/usebreakpoint-hook-ant-design-vue-4-0-0-beta-4-forked-n2k1sy?file=/src/demo.vue)).
+
+The breakpoints of responsive grid follow [BootStrap 4 media queries rules](https://getbootstrap.com/docs/4.0/layout/overview/#responsive-breakpoints)(not including `occasionally part`).

package/src/grid/index.ts

@@ -0,0 +1,11 @@
+import useBreakpoint from '../_util/hooks/useBreakpoint'
+import Col from './Col'
+import Row from './Row'
+
+export type { RowProps } from './Row'
+
+export type { ColProps, ColSize } from './Col'
+
+export { Col, Row }
+
+export default { useBreakpoint }

package/src/grid/index.zh-CN.md

@@ -0,0 +1,64 @@
+---
+category: Components
+subtitle: 栅格
+type: 布局
+cols: 1
+title: Grid
+cover: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*mfJeS6cqZrEAAAAAAAAAAAAADrJ8AQ/original
+coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*DLUwQ4B2_zQAAAAAAAAAAAAADrJ8AQ/original
+---
+
+24 栅格系统。
+
+## 设计理念
+
+<div class="grid-demo">
+  <img src="https://gw.alipayobjects.com/zos/bmw-prod/9189c9ef-c601-40dc-9960-c11dbb681888.svg" alt="grid design" />
+</div>
+
+在多数业务情况下，Ant Design Vue 需要在设计区域内解决大量信息收纳的问题，因此在 12 栅格系统的基础上，我们将整个设计建议区域按照 24 等分的原则进行划分。划分之后的信息区块我们称之为『盒子』。建议横向排列的盒子数量最多四个，最少一个。『盒子』在整个屏幕上占比见上图。设计部分基于盒子的单位定制盒子内部的排版规则，以保证视觉层面的舒适感。
+
+## 概述
+
+布局的栅格化系统，我们是基于行（row）和列（col）来定义信息区块的外部框架，以保证页面的每个区域能够稳健地排布起来。下面简单介绍一下它的工作原理：
+
+- 通过\`row\`在水平方向建立一组\`column\`（简写 col）
+- 你的内容应当放置于\`col\`内，并且，只有\`col\`可以作为\`row\`的直接元素
+- 栅格系统中的列是指 1 到 24 的值来表示其跨越的范围。例如，三个等宽的列可以使用 \`<a-col :span="8" />\` 来创建
+- 如果一个\`row\`中的\`col\`总和超过 24，那么多余的\`col\`会作为一个整体另起一行排列
+
+## Flex 布局
+
+我们的栅格化系统支持 Flex 布局，允许子元素在父节点内的水平对齐方式 - 居左、居中、居右、等宽排列、分散排列。子元素与子元素之间，支持顶部对齐、垂直居中对齐、底部对齐的方式。同时，支持使用 order 来定义元素的排列顺序。 Flex 布局是基于 24 栅格来定义每一个『盒子』的宽度，但不拘泥于栅格。
+
+## API
+
+### Row
+
+| 成员    | 说明                                                                                                                                                         | 类型                                                                                                  | 默认值 | 版本 |
+| ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------- | ------ | ---- | ---- | ---- | --------------- | -------- | -------- | -------------- | --------------- | ---------------- | ------- | ----------- |
+| align   | 垂直对齐方式                                                                                                                                                 | `top` \| `middle` \| `bottom` \| `stretch` \| `{[key in 'xs'                                          | 'sm'   | 'md' | 'lg' | 'xl' | 'xxl']: 'top'   | 'middle' | 'bottom' | 'stretch'}`    | `top`           | object: 4.0      |
+| gutter  | 栅格间隔，可以写成像素值或支持响应式的对象写法来设置水平间隔 `{ xs: 8, sm: 16, md: 24}`。或者使用数组形式同时设置 `[水平间距, 垂直间距]`（`1.5.0 后支持`）。 | number \| object \| array                                                                             | 0      | -    |
+| justify | 水平排列方式                                                                                                                                                 | `start` \| `end` \| `center` \| `space-around` \| `space-between` \| `space-evenly` \| `{[key in 'xs' | 'sm'   | 'md' | 'lg' | 'xl' | 'xxl']: 'start' | 'end'    | 'center' | 'space-around' | 'space-between' | 'space-evenly'}` | `start` | object: 4.0 |
+| wrap    | 是否自动换行                                                                                                                                                 | boolean                                                                                               | false  | -    |
+
+### Col
+
+| 成员   | 说明                                                     | 类型           | 默认值 | 版本 |
+| ------ | -------------------------------------------------------- | -------------- | ------ | ---- |
+| flex   | flex 布局填充                                            | string\|number | -      |      |
+| offset | 栅格左侧的间隔格数，间隔内不可以有栅格                   | number         | 0      |      |
+| order  | 栅格顺序，`flex` 布局模式下有效                          | number         | 0      |      |
+| pull   | 栅格向左移动格数                                         | number         | 0      |      |
+| push   | 栅格向右移动格数                                         | number         | 0      |      |
+| span   | 栅格占位格数，为 0 时相当于 `display: none`              | number         | -      |      |
+| xs     | `<576px` 响应式栅格，可为栅格数或一个包含其他属性的对象  | number\|object | -      |      |
+| sm     | `≥576px` 响应式栅格，可为栅格数或一个包含其他属性的对象  | number\|object | -      |      |
+| md     | `≥768px` 响应式栅格，可为栅格数或一个包含其他属性的对象  | number\|object | -      |      |
+| lg     | `≥992px` 响应式栅格，可为栅格数或一个包含其他属性的对象  | number\|object | -      |      |
+| xl     | `≥1200px` 响应式栅格，可为栅格数或一个包含其他属性的对象 | number\|object | -      |      |
+| xxl    | `≥1600px` 响应式栅格，可为栅格数或一个包含其他属性的对象 | number\|object | -      |      |
+
+您可以使用 [主题定制](/docs/vue/customize-theme-cn) 修改 `screen[XS|SM|MD|LG|XL|XXL]` 来修改断点值（自 4.0.0 起，[codesandbox demo](https://codesandbox.io/s/usebreakpoint-hook-ant-design-vue-4-0-0-beta-4-forked-n2k1sy?file=/src/demo.vue)）。
+
+响应式栅格的断点扩展自 [BootStrap 4 的规则](https://getbootstrap.com/docs/4.0/layout/overview/#responsive-breakpoints)（不包含链接里 `occasionally` 的部分)。

package/src/grid/style/index.ts

@@ -0,0 +1,179 @@
+import type { CSSObject } from '../../_util/cssinjs'
+import type { FullToken, GenerateStyle } from '../../theme/internal'
+import { genComponentStyleHook, mergeToken } from '../../theme/internal'
+
+interface GridRowToken extends FullToken<'Grid'> {}
+
+interface GridColToken extends FullToken<'Grid'> {
+  gridColumns: number
+}
+
+// ============================== Row-Shared ==============================
+const genGridRowStyle: GenerateStyle<GridRowToken> = (token): CSSObject => {
+  const { componentCls } = token
+
+  return {
+    // Grid system
+    [componentCls]: {
+      display: 'flex',
+      flexFlow: 'row wrap',
+      minWidth: 0,
+
+      '&::before, &::after': {
+        display: 'flex',
+      },
+
+      '&-no-wrap': {
+        flexWrap: 'nowrap',
+      },
+
+      // The origin of the X-axis
+      '&-start': {
+        justifyContent: 'flex-start',
+      },
+
+      // The center of the X-axis
+      '&-center': {
+        justifyContent: 'center',
+      },
+
+      // The opposite of the X-axis
+      '&-end': {
+        justifyContent: 'flex-end',
+      },
+
+      '&-space-between': {
+        justifyContent: 'space-between',
+      },
+
+      '&-space-around ': {
+        justifyContent: 'space-around',
+      },
+
+      '&-space-evenly ': {
+        justifyContent: 'space-evenly',
+      },
+
+      // Align at the top
+      '&-top': {
+        alignItems: 'flex-start',
+      },
+
+      // Align at the center
+      '&-middle': {
+        alignItems: 'center',
+      },
+
+      '&-bottom': {
+        alignItems: 'flex-end',
+      },
+    },
+  }
+}
+
+// ============================== Col-Shared ==============================
+const genGridColStyle: GenerateStyle<GridColToken> = (token): CSSObject => {
+  const { componentCls } = token
+
+  return {
+    // Grid system
+    [componentCls]: {
+      position: 'relative',
+      maxWidth: '100%',
+      // Prevent columns from collapsing when empty
+      minHeight: 1,
+    },
+  }
+}
+
+const genLoopGridColumnsStyle = (token: GridColToken, sizeCls: string): CSSObject => {
+  const { componentCls, gridColumns } = token
+
+  const gridColumnsStyle: CSSObject = {}
+  for (let i = gridColumns; i >= 0; i--) {
+    if (i === 0) {
+      gridColumnsStyle[`${componentCls}${sizeCls}-${i}`] = {
+        display: 'none',
+      }
+      gridColumnsStyle[`${componentCls}-push-${i}`] = {
+        insetInlineStart: 'auto',
+      }
+      gridColumnsStyle[`${componentCls}-pull-${i}`] = {
+        insetInlineEnd: 'auto',
+      }
+      gridColumnsStyle[`${componentCls}${sizeCls}-push-${i}`] = {
+        insetInlineStart: 'auto',
+      }
+      gridColumnsStyle[`${componentCls}${sizeCls}-pull-${i}`] = {
+        insetInlineEnd: 'auto',
+      }
+      gridColumnsStyle[`${componentCls}${sizeCls}-offset-${i}`] = {
+        marginInlineEnd: 0,
+      }
+      gridColumnsStyle[`${componentCls}${sizeCls}-order-${i}`] = {
+        order: 0,
+      }
+    } else {
+      gridColumnsStyle[`${componentCls}${sizeCls}-${i}`] = {
+        display: 'block',
+        flex: `0 0 ${(i / gridColumns) * 100}%`,
+        maxWidth: `${(i / gridColumns) * 100}%`,
+      }
+      gridColumnsStyle[`${componentCls}${sizeCls}-push-${i}`] = {
+        insetInlineStart: `${(i / gridColumns) * 100}%`,
+      }
+      gridColumnsStyle[`${componentCls}${sizeCls}-pull-${i}`] = {
+        insetInlineEnd: `${(i / gridColumns) * 100}%`,
+      }
+      gridColumnsStyle[`${componentCls}${sizeCls}-offset-${i}`] = {
+        marginInlineStart: `${(i / gridColumns) * 100}%`,
+      }
+      gridColumnsStyle[`${componentCls}${sizeCls}-order-${i}`] = {
+        order: i,
+      }
+    }
+  }
+
+  return gridColumnsStyle
+}
+
+const genGridStyle = (token: GridColToken, sizeCls: string): CSSObject =>
+  genLoopGridColumnsStyle(token, sizeCls)
+
+const genGridMediaStyle = (
+  token: GridColToken,
+  screenSize: number,
+  sizeCls: string,
+): CSSObject => ({
+  [`@media (min-width: ${screenSize}px)`]: {
+    ...genGridStyle(token, sizeCls),
+  },
+})
+
+// ============================== Export ==============================
+export const useRowStyle = genComponentStyleHook('Grid', (token) => [genGridRowStyle(token)])
+
+export const useColStyle = genComponentStyleHook('Grid', (token) => {
+  const gridToken: GridColToken = mergeToken<GridColToken>(token, {
+    gridColumns: 24, // Row is divided into 24 parts in Grid
+  })
+
+  const gridMediaSizesMap = {
+    '-sm': gridToken.screenSMMin,
+    '-md': gridToken.screenMDMin,
+    '-lg': gridToken.screenLGMin,
+    '-xl': gridToken.screenXLMin,
+    '-xxl': gridToken.screenXXLMin,
+  }
+
+  return [
+    genGridColStyle(gridToken),
+    genGridStyle(gridToken, ''),
+    genGridStyle(gridToken, '-xs'),
+    Object.keys(gridMediaSizesMap)
+      .map((key: keyof typeof gridMediaSizesMap) =>
+        genGridMediaStyle(gridToken, gridMediaSizesMap[key], key),
+      )
+      .reduce((pre, cur) => ({ ...pre, ...cur }), {}),
+  ]
+})

package/src/icon/index.en-US.md

@@ -0,0 +1,247 @@
+---
+category: Components
+type: General
+title: Icon
+cover: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*PdAYS7anRpoAAAAAAAAAAAAADrJ8AQ/original
+coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*xEDOTJx2DEkAAAAAAAAAAAAADrJ8AQ/original
+---
+
+Semantic vector graphics. Before use icons, you need to install `@ant-design/icons-vue` package:
+
+```bash
+npm install --save @ant-design/icons-vue
+```
+
+## API
+
+### Common Icon
+
+| Property     | Description                                                 | Type               | Default | Version |
+| ------------ | ----------------------------------------------------------- | ------------------ | ------- | ------- |
+| rotate       | Rotate by n degrees (not working in IE9)                    | number             | -       |         |
+| spin         | Rotate icon with animation                                  | boolean            | false   |         |
+| style        | Style properties of icon, like `fontSize` and `color`       | CSSProperties      | -       |         |
+| twoToneColor | Only supports the two-tone icon. Specify the primary color. | string (hex color) | -       |         |
+
+We still have three different themes for icons, icon component name is the icon name suffixed by the theme name.
+
+```jsx
+import { StarOutlined, StarFilled, StarTwoTone } from '@ant-design/icons-vue';
+
+<star-outlined />
+<star-filled />
+<star-two-tone two-tone-color="#eb2f96" />
+```
+
+### Custom Icon
+
+| Property  | Description                                           | Type                                       | Default | Version |
+| --------- | ----------------------------------------------------- | ------------------------------------------ | ------- | ------- |
+| component | The component used for the root node.                 | ComponentType&lt;CustomIconComponentProps> | -       |         |
+| rotate    | Rotate degrees (not working in IE9)                   | number                                     | -       |         |
+| spin      | Rotate icon with animation                            | boolean                                    | false   |         |
+| style     | Style properties of icon, like `fontSize` and `color` | CSSProperties                              | -       |         |
+
+### About SVG icons
+
+We introduced SVG icons in version `1.2.0`, replacing font icons. This has the following benefits:
+
+- Complete offline usage of icons, without dependency on a CDN-hosted font icon file (No more empty square during downloading and no need to deploy icon font files locally either!)
+- Much more display accuracy on lower-resolution screens
+- The ability to choose icon color
+- No need to change built-in icons with overriding styles by providing more props in component
+
+More discussion of SVG icon reference at [#10353](https://github.com/ant-design/ant-design/issues/10353).
+
+> ⚠️ Given the extra bundle size caused by all SVG icons imported in 1.2.0, we will provide a new API to allow developers to import icons as needed, you can track [#12011](https://github.com/ant-design/ant-design/issues/12011) for updates.
+>
+> While you wait, you can use [webpack plugin](https://github.com/Beven91/webpack-ant-icon-loader) from the community to chunk the icon file.
+
+The properties `theme`, `component` and `twoToneColor` were added in `1.2.0`. The best practice is to pass the property `theme` to every `<Icon />` component.
+
+```html
+<template>
+  <message-outlined :style="{fontSize: '16px', color: '#08c'}" />
+</template>
+<script>
+  import { MessageOutlined } from '@ant-design/icons-vue'
+
+  import { defineComponent } from 'vue'
+
+  export default defineComponent({
+    components: {
+      MessageOutlined,
+    },
+  })
+</script>
+```
+
+All the icons will render to `<svg>`. You can still set `style` and `class` for size and color of icons.
+
+### Set TwoTone Color
+
+When using the two-tone icons, you can use the static methods `getTwoToneColor()` and `setTwoToneColor(colorString)` to spicify the primary color.
+
+```jsx
+import { getTwoToneColor, setTwoToneColor } from '@ant-design/icons'
+
+setTwoToneColor('#eb2f96')
+getTwoToneColor() // #eb2f96
+```
+
+### Custom Font Icon
+
+We added a `createFromIconfontCN` function to help developer using their own icons deployed at [iconfont.cn](http://iconfont.cn/) in a convenient way.
+
+> This method is specified for [iconfont.cn](http://iconfont.cn/).
+
+```jsx
+import { createFromIconfontCN } from '@ant-design/icons-vue'
+
+import { defineComponent } from 'vue'
+
+const MyIcon = createFromIconfontCN({
+  scriptUrl: '//at.alicdn.com/t/font_8d5l8fzk5b87iudi.js', // generated by iconfont.cn
+})
+
+export default defineComponent({
+  setup() {
+    return () => <MyIcon type="icon-dianzan" />
+  },
+})
+```
+
+It create a component that uses SVG sprites in essence.
+
+The following options are available:
+
+| Property         | Description                                                      | Type                                 | Default |
+| ---------------- | ---------------------------------------------------------------- | ------------------------------------ | ------- |
+| extraCommonProps | Define extra properties to the component                         | `{ class, attrs, props, on, style }` | {}      |
+| scriptUrl        | The URL generated by [iconfont.cn](http://iconfont.cn/) project. | string                               | -       |
+
+The property `scriptUrl` should be set to import the SVG sprite symbols.
+
+See [iconfont.cn documents](http://iconfont.cn/help/detail?spm=a313x.7781069.1998910419.15&helptype=code) to learn about how to generate `scriptUrl`.
+
+### Custom SVG Icon
+
+#### vue cli 3
+
+You can import SVG icon as an vue component by using `vue cli 3` and [`vue-svg-loader`](https://www.npmjs.com/package/vue-svg-loader). `vue-svg-loader`'s `options` [reference](https://github.com/visualfanatic/vue-svg-loader).
+
+```js
+// vue.config.js
+module.exports = {
+  chainWebpack: (config) => {
+    const svgRule = config.module.rule('svg')
+
+    svgRule.uses.clear()
+
+    svgRule.use('vue-svg-loader').loader('vue-svg-loader')
+  },
+}
+```
+
+```jsx
+import Icon from '@ant-design/icons-vue'
+import MessageSvg from 'path/to/message.svg'
+
+import { defineComponent } from 'vue'
+
+// path to your '*.svg' file.
+
+export default defineComponent({
+  setup() {
+    return () => <Icon type={MessageSvg} />
+  },
+})
+```
+
+#### Rsbuild
+
+Rsbuild is a new generation of build tool, official website https://rsbuild.dev/  
+Create your own `vue-svg-loader.js` file, which allows you to customize and beautify SVG, and then configure it in `rsbuild.config.ts`
+
+```js
+// vue-svg-loader.js
+
+const { optimize } = require('svgo')
+const { version } = require('vue')
+const semverMajor = require('semver/functions/major')
+
+module.exports = async function (svg) {
+  const callback = this.async()
+
+  try {
+    ;({ data: svg } = await optimize(svg, {
+      path: this.resourcePath,
+      js2svg: {
+        indent: 2,
+        pretty: true,
+      },
+      plugins: [
+        'convertStyleToAttrs',
+        'removeDoctype',
+        'removeXMLProcInst',
+        'removeComments',
+        'removeMetadata',
+        'removeTitle',
+        'removeDesc',
+        'removeStyleElement',
+        'removeXMLNS',
+        'removeXMLProcInst',
+      ],
+    }))
+  } catch (error) {
+    callback(error)
+    return
+  }
+
+  if (semverMajor(version) === 2) {
+    svg = svg.replace('<svg', '<svg v-on="$listeners"')
+  }
+
+  callback(null, `<template>${svg}</template>`)
+}
+```
+
+```js
+// rsbuild.config.ts
+/* eslint-disable */
+import { defineConfig } from '@rsbuild/core'
+import { pluginVue } from '@rsbuild/plugin-vue'
+
+export default defineConfig({
+  tools: {
+    bundlerChain(chain, { CHAIN_ID }) {
+      chain.module.rule(CHAIN_ID.RULE.SVG).exclude.add(/\.svg$/)
+    },
+    rspack: {
+      module: {
+        rules: [
+          {
+            test: /\.svg$/,
+            use: ['vue-loader', 'vue-svg-loader'],
+          },
+        ],
+      },
+      resolveLoader: {
+        alias: {
+          'vue-svg-loader': require('path').join(__dirname, './vue-svg-loader.js'),
+        },
+      },
+    },
+  },
+})
+```
+
+The following properties are available for the component:
+
+| Property | Description                                      | Type             | Default        |
+| -------- | ------------------------------------------------ | ---------------- | -------------- |
+| class    | The computed class name of the `svg` element     | string           | -              |
+| fill     | Define the color used to paint the `svg` element | string           | 'currentColor' |
+| height   | The height of the `svg` element                  | string \| number | '1em'          |
+| style    | The computed style of the `svg` element          | CSSProperties    | -              |
+| width    | The width of the `svg` element                   | string \| number | '1em'          |

package/src/icon/index.tsx

@@ -0,0 +1,11 @@
+import { withInstall } from '../_util/type'
+import warning from '../_util/warning'
+
+const Icon = () => {
+  warning(false, 'Icon', 'Empty Icon')
+  return null
+}
+
+Icon.displayName = 'AIcon'
+
+export default withInstall(Icon)