@alauda/ui 6.2.3-beta.8 → 6.2.3-beta.9

package/src/accordion/README.md

@@ -1,13 +0,0 @@
-# Accordion (<aui-accordion>)
-
-## Attributes
-
-| 参数  | 说明           | 类型    | 默认值 |
-| ----- | -------------- | ------- | ------ |
-| multi | 可同时展开多个 | boolean | false  |
-
-## Events
-
-| 事件名称       | 说明                                | 回调参数                              |
-| -------------- | ----------------------------------- | ------------------------------------- |
-| expandedChange | auiAccordionItemHeader 被点击时触发 | boolean(当前 toggle 是否被打开的状态) |

package/src/anchor/README.md

@@ -1,23 +0,0 @@
-# Anchor Module
-
-## AnchorDirective(`[auiAnchor]`)
-
-### AnchorDirective Inputs
-
-| 参数          | 说明                                                                                                       | 类型                    | 默认值      |
-| ------------- | ---------------------------------------------------------------------------------------------------------- | ----------------------- | ----------- |
-| auiAnchor     | 滚动容器, 不传值默认取 `cdkScrollable` 或当前元素（如果可滚动）或 `window`                                 | `HTMLElement`           | `undefined` |
-| adaptPosition | 是否自动调整当前元素 `paddingRight` 以保证与自动生成的锚点内容重叠                                         | `boolean`               | `true`      |
-| padding       | 自动调整 `paddingRight` 时自动保持与自动生成的锚点内容的距离                                               | `number`                | `20`        |
-| minTop        | 当滚动页面时自动生成的锚点内容距离页面顶部最小距离，默认取当前 `.aui-page__content` 元素的 `paddingTop` 值 | `number`                | `20`        |
-| injectId      | 是否自动在 `auiAnchorLabel` 元素上注入 id，将自动生成 `#` 可记录锚点                                       | `window === window.top` |
-
-## AnchorLabelDirective(`[auiAnchorLabel]`)
-
-### AnchorLabelDirective Inputs
-
-| 参数                  | 说明                                                          | 类型                    | 默认值      |
-| --------------------- | ------------------------------------------------------------- | ----------------------- | ----------- |
-| auiAnchorLabel        | 自动生成锚点时对应文本内容，默认取当前元素文本内容            | `string \| TemplateRef` | `undefined` |
-| auiAnchorLabelContext | 使用 `TemplateRef` 类型 `auiAnchorLabel` 时的上下文           | `unknown`               | `undefined` |
-| level                 | 锚点层级，不写这个 `input` 默认是 `0`，写了不填内容默认是 `1` | `string \| TemplateRef` | `0`         |

package/src/dropdown/README.md

@@ -1,57 +0,0 @@
-# Dropdown Module
-
-## Dropdown
-
-### Dropdown Attributes
-
-| 参数                | 说明             | 类型          | 默认值       |
-| ------------------- | ---------------- | ------------- | ------------ |
-| auiDropdown         | menu 模板        | MenuComponent | -            |
-| auiDropdownContext  | template context | any           | -            |
-| auiDropdownPosition | menu 弹出位置    | string        | 'bottom end' |
-| auiDropdownDisabled | 禁用 dropdown    | boolean       | false        |
-
-## Menu
-
-### Menu Attributes
-
-| 参数 | 说明      | 类型          | 默认值               |
-| ---- | --------- | ------------- | -------------------- |
-| size | menu 大小 | ComponentSize | ComponentSize.Medium |
-
-## MenuItem
-
-### MenuItem Attributes
-
-| 参数     | 说明                 | 类型    | 默认值 |
-| -------- | -------------------- | ------- | ------ |
-| disabled | 是否禁用             | boolean | false  |
-| divide   | 是否在顶部显示分割线 | boolean | false  |
-
-## Submenu
-
-### Submenu Attributes
-
-| 参数     | 说明                 | 类型           | 默认值               |
-| -------- | -------------------- | -------------- | -------------------- |
-| disabled | 是否禁用             | boolean        | false                |
-| trigger  | 触发方式             | TooltipTrigger | TooltipTrigger.Hover |
-| divide   | 是否在顶部显示分割线 | boolean        | false                |
-| size     | menu 大小            | ComponentSize  | ComponentSize.Medium |
-
-## DropdownButton
-
-### DropdownButton Attributes
-
-| 参数     | 说明                     | 类型          | 默认值               |
-| -------- | ------------------------ | ------------- | -------------------- |
-| type     | 按钮类型                 | ButtonType    | ButtonType.Default   |
-| size     | 组件大小                 | ComponentSize | ComponentSize.Medium |
-| loading  | 外部按钮是否显示 loading | boolean       | false                |
-| disabled | 是否禁用外部按钮         | boolean       | false                |
-
-### Events
-
-| 事件名称    | 说明           | 回调参数 |
-| ----------- | -------------- | -------- |
-| buttonClick | 外部按钮被点击 | Event    |

package/src/form/README.md

@@ -1,32 +0,0 @@
-# Form Module
-
-## FormItem
-
-### FormItem Attributes
-
-| 参数          | 说明                | 类型           | 默认值 |
-| ------------- | ------------------- | -------------- | ------ |
-| labelWidth    | 标签宽度            | string         | auto   |
-| labelPosition | 标签位置            | left,right,top | right  |
-| emptyAddon    | 添加 addon 占位元素 | boolean        | false  |
-
-### FormItem Contents
-
-| 选择器                   | 说明     |
-| ------------------------ | -------- |
-| `label[rcFormItemLabel]` | 标签     |
-| `[rcFormItemControl]`    | 表单元素 |
-| `[rcFormItemHint]`       | 信息提示 |
-| `[rcFormItemError]`      | 错误提示 |
-| `[rcFormItemAddon]`      | 插件     |
-
-## Form
-
-### Form Attributes
-
-| 参数                 | 说明                | 类型           | 默认值 |
-| -------------------- | ------------------- | -------------- | ------ |
-| auiFormLabelWidth    | 标签宽度            | string         | auto   |
-| auiFormLabelPosition | 标签位置            | left,right,top | right  |
-| auiFormEmptyAddon    | 添加 addon 占位元素 | boolean        | false  |
-| auiFormInline        | 单行显示            | boolean        | false  |

package/src/icon/README.md

@@ -1,28 +0,0 @@
-# Icon
-
-## Attributes
-
-| 参数   | 说明                                      | 类型           | 默认值 |
-| ------ | ----------------------------------------- | -------------- | ------ |
-| icon   | icon 名称，用 `:` 将 namespace 和 id 隔开 | string         | none   |
-| link   | 外链 svg 地址                             | string         | -      |
-| margin | 在左、右方添加边距                        | 'left'/'right' | -      |
-
-## IconRegistryService
-
-| 名称                       | 参数        | 说明                                                                  |
-| -------------------------- | ----------- | --------------------------------------------------------------------- |
-| registrySvgSymbolsByUrl    | url: string | 异步加载 svg 文件，要注意预防脚本注入攻击，确保 url 和 响应是可信任的 |
-| registrySvgSymbolsByString | str: string | 将 svg 字符串添加到文档，确保字符串是可信任的                         |
-
-## Read More
-
-主要考虑了三种实现方式：`font icon`，`inline svg`，`svg symbols`。
-
-- `font icon`：目前使用最广泛最成熟的方案，但因为[一些缺陷](https://css-tricks.com/icon-fonts-vs-svg/)业内开始不再推崇这种方式。针对 `aui-icon` 的使用场景主要缺陷是可能出现的渲染问题。
-- `inline svg`：实现上比较麻烦，DOM 操作太多。
-- `svg symbols`：具有 `inline svg` 的所有优点，使用简单优雅。缺陷是浏览器兼容性，IE 所有不支持外链 svg，所以需要将 svg 插入到文档中。
-
-## 使用自定义图标
-
-通过静态文件目录、webpack 打包等方式将 symbol svg 文件发布到线上，并在使用图标前（通常是 app 初始化时）通过 `IconRegistryService` 服务的 `registryByUrl()` 方法注册图标文件，参数为图标对应的 url，服务将自动加载图标并将其添加到文档中。之后在使用时将图标 ID 以 `{namespace}:{name}` 的格式传给 icon 组件即可。

package/src/inline-alert/README.md

@@ -1,16 +0,0 @@
-# Inline Alert
-
-## Attributes
-
-| 参数     | 说明       | 类型            | 默认值               |
-| -------- | ---------- | --------------- | -------------------- |
-| title    | 标题       | string          | -                    |
-| content  | 内容       | string          | -                    |
-| type     | 类型       | InlineAlertType | InlineAlertType.Info |
-| closable | 是否可关闭 | boolean         | false                |
-
-## Events
-
-| 事件名称 | 说明                     | 回调参数 |
-| -------- | ------------------------ | -------- |
-| close    | 关闭 Inline Alert 时触发 | -        |

package/src/input/number-input/README.md

@@ -1,15 +0,0 @@
-# Number-input (<aui-number-input>)
-
-## Attributes
-
-| 参数             | 说明                   | 类型          | 默认值                  |
-| ---------------- | ---------------------- | ------------- | ----------------------- |
-| size             | 尺寸                   | ComponentSize | ComponentSize.Medium    |
-| disabled         | 禁用                   | boolean       | false                   |
-| min              | 最小值                 | number        | -                       |
-| max              | 最大值                 | number        | Number.MAX_SAFE_INTEGER |
-| step             | 计数器步长             | number        | 1                       |
-| precision        | 数值精度               | number        | 0                       |
-| controls         | 是否使用控制按钮       | boolean       | true                    |
-| placeholder      | 占位符                 | string        | ''                      |
-| controlsPosition | 控制按钮位置(暂未实现) | string        | -                       |

package/src/select/README.md

@@ -1,57 +0,0 @@
-## Select
-
-### Select Attributes
-
-| 参数        | 说明                                         | 类型               | 默认值                  |
-| ----------- | -------------------------------------------- | ------------------ | ----------------------- |
-| size        | 尺寸                                         | ComponentSize      | ComponentSize.Medium    |
-| placeholder | 占位符                                       | string             | -                       |
-| disabled    | 禁用                                         | boolean            | false                   |
-| loading     | 加载状态                                     | boolean            | false                   |
-| value       | 选中值                                       | T                  | -                       |
-| filterable  | 是否可过滤选项                               | boolean            | false                   |
-| filterFn    | 过滤函数                                     | OptionFilterMethod | Array.property.includes |
-| allowCreate | 是否允许创建新值，需要和 filterable 一起打开 | boolean            | false                   |
-| clearable   | 是否可清空选项                               | boolean            | false                   |
-| trackFn     | 返回 value 唯一标识符                        | TrackFn            | val => val              |
-
-### Select Events
-
-| 时间名称     | 说明         | 回调参数      |
-| ------------ | ------------ | ------------- |
-| valueChange  | 选中值变化   | value: T      |
-| filterChange | input 值变化 | value: string |
-
-## MultiSelect
-
-### MultiSelect Attributes
-
-| 参数        | 说明                                         | 类型           | 默认值                  |
-| ----------- | -------------------------------------------- | -------------- | ----------------------- |
-| size        | 尺寸                                         | ComponentSize  | ComponentSize.Medium    |
-| placeholder | 占位符                                       | string         | -                       |
-| disabled    | 禁用                                         | boolean        | false                   |
-| loading     | 加载状态                                     | boolean        | false                   |
-| value       | 选中值                                       | T[]            | []                      |
-| filterable  | 是否可过滤选项                               | boolean        | false                   |
-| filterFn    | 过滤函数                                     | OptionFilterFn | Array.property.includes |
-| allowCreate | 是否允许创建新值，需要和 filterable 一起打开 | boolean        | false                   |
-| clearable   | 是否可清空选项                               | boolean        | false                   |
-| trackFn     | 返回 value 唯一标识符                        | TrackFn        | val => val              |
-
-### MultiSelect Events
-
-| 事件名称     | 说明         | 回调参数      |
-| ------------ | ------------ | ------------- |
-| valueChange  | 选中值变化   | value: T      |
-| filterChange | input 值变化 | value: string |
-
-## Option
-
-### Option Attributes
-
-| 参数     | 说明                     | 类型    | 默认值 |
-| -------- | ------------------------ | ------- | ------ |
-| label    | 选中后 select 显示的文案 | string  | -      |
-| value    | 选中值                   | T       | -      |
-| disabled | 禁用                     | boolean | false  |

package/src/sort/README.md

@@ -1,13 +0,0 @@
-### 设计
-
-基于 angular/material 的 MatSort 及 MatSortHeader 原始代码修改，修改样式，移除 Alauda UI 不需要的功能，目的是保持组件尽可能简单，避免无关功能干扰开发，变更功能如下：
-
-- sort disable 相关代码
-- sort indicator 样式修改，并去除原有动画相关代码，原有动画仅适合箭头，Alauda UI 的设计并不适合添加动画
-- 排序清除功能(asc -> desc -> no sort)，Alauda UI 的设计并未考虑这块功能，考虑这块功能不是非常必要，而且会增加一个排序状态，操作稍显繁琐。
-- 无障碍相关功能（后续结合实际情况考虑是否加入）
-
-### 使用
-
-- [material2 sort.md](https://github.com/angular/material2/blob/master/src/lib/sort/sort.md)
-- [material2 document](https://material.angular.io/components/sort/overview)

package/src/table/README.md

@@ -1,8 +0,0 @@
-## 设计
-
-基于 angular/material 的 MatTable 修改，功能基本一致，仅移除 MatTableDataSource 相关代码`（MatTableDataSource和MatTable本身并无关系，而且功能并不适合基于服务端的排序及过滤，未来是否会抽取适合服务端的排序及过滤功能还需要考虑）`，样式按 Alauda UI 设计规范调整 。MatTable 相关组件基于 CdkTable 开发，未来 AuiTable 的功能变更会结合 CdkTable 来做。CdkTable 的[设计目标](https://docs.google.com/document/d/1ZyKhwrgqfTBAn7saTq2jPlep2_CwSw5DeoZ8UbaXrC0/preview)和 AuiTable 有很多共同点，可以作为一个后续功能迭代的基础。
-
-## 使用
-
-- [material2 table.md](https://github.com/angular/components/blob/master/src/cdk/table/table.md)
-- [material2 document](https://material.angular.io/components/table/overview)

package/src/table-of-contents/README.md

@@ -1,79 +0,0 @@
-Features:
-
-- Active link and content when content visible in scroll container.
-- Smooth scroll to content when click link.
-- Support programmable scroll to content.
-- Support nested content.
-
-Limit:
-
-- container must scrollable.
-- link active or fix position styles not included.
-- if scroll to then end, scrollHeight - scrollTop === clientHeight, set last content active.
-
-Simplest usage:
-
-```html
-<!-- links -->
-<aside>
-  <a auiTocLink="content1" [for]="toc">content1</a>
-  <a auiTocLink="content2" [for]="toc">content2</a>
-  <a auiTocLink="content3" [for]="toc">content3</a>
-</aside>
-<!-- scroll container -->
-<article auiTocContainer #toc="auiTocContainer">
-  <section auiTocContent="content1">...</section>
-  <section auiTocContent="content2">...</section>
-  <section auiTocContent="content3">...</section>
-</article>
-```
-
-Directives:
-
-- `auiTocContainer`
-
-  ```ts
-  @Output() activedChange: EventEmitter<string>;
-  ```
-
-  emit when actived change, use this for self define links active.
-
-  ```ts
-  scrollTo(content: string): void;
-  ```
-
-  programmable scroll to content.
-
-- `auiTocContent`
-
-  ```ts
-  @Input('auiTocContent') auiTocContent: string;
-  ```
-
-  set content name, must unique in same container.
-
-  ```ts
-  @HostBinding('class.isActive') active: boolean;
-  ```
-
-  you need define content `isActive` class for content styling when active.
-
-- (Optional) `auiTocLink`
-
-  ```ts
-  @Input() for: TocContainerDirective;
-  ```
-
-  scroll container template reference variable
-
-  ```ts
-  @Input('auiTocLink') auiTocLink: string;
-  ```
-
-  link target content name.
-
-  ```ts
-  @HostBinding('class.isActive') active: boolean;
-  ```
-
-  you need define link `isActive` class for link styling when active.

package/src/tag/README.md

@@ -1,32 +0,0 @@
-## Tag
-
-### Tag Attributes
-
-| 参数      | 说明                                                              | 类型          | 默认值               |
-| --------- | ----------------------------------------------------------------- | ------------- | -------------------- |
-| type      | 主题                                                              | TagType       | TagType.Primary      |
-| size      | 尺寸                                                              | ComponentSize | ComponentSize.Medium |
-| closeable | 是否可关闭                                                        | boolean       | false                |
-| solid     | 是否实心                                                          | boolean       | false                |
-| color     | 自定义颜色，可以 `,` 分隔两个色值，第一个值为主色，第二个为背景色 | string        | -                    |
-
-### Tag Events
-
-| 事件名称 | 说明            | 回调参数 |
-| -------- | --------------- | -------- |
-| close    | 关闭 tag 时触发 | -        |
-
-## CheckTag
-
-### CheckTag Attributes
-
-| 参数    | 说明     | 类型          | 默认值               |
-| ------- | -------- | ------------- | -------------------- |
-| checked | 是否选中 | boolean       | false                |
-| size    | 尺寸     | ComponentSize | ComponentSize.medium |
-
-### CheckTag Events
-
-| 事件名称      | 说明            | 回调参数 |
-| ------------- | --------------- | -------- |
-| checkedChange | 点击 tag 时触发 | boolean  |

package/src/tree-select/README.md

@@ -1,34 +0,0 @@
-# TreeSelect Module
-
-## TreeSelect
-
-### TreeSelect Attributes
-
-| 参数        | 说明           | 类型               | 默认值                  |
-| ----------- | -------------- | ------------------ | ----------------------- |
-| placeholder | 占位符         | string             | -                       |
-| disabled    | 禁用           | boolean            | false                   |
-| loading     | 加载状态       | boolean            | false                   |
-| value       | 选中值         | any                | -                       |
-| filterable  | 是否可过滤选项 | boolean            | false                   |
-| filterFn    | 过滤函数       | OptionFilterMethod | Array.property.includes |
-| clearable   | 是否可清空选项 | boolean            | false                   |
-
-### TreeSelect Events
-
-| 时间名称     | 说明         | 回调参数      |
-| ------------ | ------------ | ------------- |
-| valueChange  | 选中值变化   | value: any    |
-| filterChange | input 值变化 | value: string |
-
-## TreeNode
-
-### TreeNode Attributes
-
-| 参数     | 说明                     | 类型    | 默认值 |
-| -------- | ------------------------ | ------- | ------ |
-| label    | 选中后 select 显示的文案 | string  | -      |
-| value    | 选中值                   | any     | -      |
-| disabled | 禁用                     | boolean | false  |
-| expanded | 是否默认展开节点         | boolean | false  |
-| leafOnly | 只允许选择叶子节点       | boolean | false  |