@ gravity-ui/ 正常化的列表
软件包的核心是 useNormalizedList: 它需要将列表项目输入其中之一 a 平顶 或者说 树 形状并把它们变成一个常态模型——id-keyed data,分级元,可见顺序,以及交互状态(选择,扩展,焦点).
UI 组件(NormalizedList, (中文(简体) ), NormalizedSelect,可选的 UIKit 层) 在那个模型之上 并保持自定义 通过制作道具.
安装
npm install @gravity-ui/normalized-list
核心条目的对等依赖性(@gravity-ui/normalized-list: react 财务报告和审定财务报表 react-dom 带范围 ^16.14.0 || ^17.0.0 || ^18.0.0 || ^19.0.0。 。 。 .
这个 @gravity-ui/normalized-list/uikit 需要输入 UIKit 8 软件 (单位:千美元)@gravity-ui/uikit@^8.0.0和 反应 18 或 19 (两者) react 财务报告和审定财务报表 react-dom. UIKit 7 本条目不再支持.
npm install @gravity-ui/normalized-list @gravity-ui/uikit@^8.0.0
UIKit 条目也需要 @gravity-ui/icons 财务报告和审定财务报表 @floating-ui/react。安装 @gravity-ui/uikit 通常足够(它已经取决于其他两个)。 安装 pnpm 等严格的软件包管理器 @gravity-ui/icons 财务报告和审定财务报表 @floating-ui/react 如果他们不下决心的话.
从 @gravity-ui/uikit/unstable (单位:千美元)TreeSelect, (中文(简体) ), TreeList, (中文(简体) ), useList{\fn黑体\fs22\bord1\shad0\3aHBE\4aH00\fscx67\fscy66\2cHFFFFFF\3cH808080}你觉得呢? 见 移民.md。 。 。 .
思想
items (flat | tree)
│
▼
useNormalizedList
│
├─ structure → itemsById, groupsState, visibleFlattenIds, …
└─ state → selectedById, expandedById, activeItemId, …
│
▼
NormalizedList / NormalizedSelect
(or your own view / UIKitNormalized*)
钩子解决的是什么:
- 一个 API 用于 平顶 财务报告和审定财务报表 树 编写格式;
- O(1) 恢复正常后由身份证进入;
- 选择 / 扩展 / 键盘友好 可见 顺序 (
visibleFlattenIds(三); - UI 保持哑巴:通过
list用于自定义渲染.
两个输入形状
有效载荷 T 这是你的。 名单合同只是 节点包装数字 :
平板电脑 - 项目是 T 本身( 可选 id 编号 : selected 编号 : disabled:
import type {ListItemType} from '@gravity-ui/normalized-list';
const flat: ListItemType<string>[] = ['one', 'two', 'three'];
const flatObjects: ListItemType<{title: string}>[] = [
{title: 'one'},
{title: 'two', selected: true},
];
树 - 东西有 data: T 和可选 children数字 :
const tree: ListItemType<{title: string}>[] = [
{
data: {title: 'Fruits'},
children: [{data: {title: 'Apple'}}, {data: {title: 'Orange'}}],
},
];
都归正了 structure + 键 state。 。 。 .
软件包布局
| 条目 | 导入 | 你得到的东西 |
|---|---|---|
| 核心 | @gravity-ui/normalized-list | useNormalizedList, (中文(简体) ), NormalizedList, (中文(简体) ), NormalizedSelect无头建筑构件 |
| 用户界面Kit | @gravity-ui/normalized-list/uikit | UIKitNormalizedList, (中文(简体) ), UIKitNormalizedSelect,主题项目/控制视图 |
核心舰a 最小后退 UI 当你忽略了制取道具。 用于生产,通过自己的渲染器或使用UIKit条目.
快开始
1. 仅钩子
import {useNormalizedList} from '@gravity-ui/normalized-list';
const list = useNormalizedList({
items: ['one', 'two', 'three'],
getItemId: (item) => item,
});
// list.structure.itemsById
// list.structure.visibleFlattenIds
// list.state.selectedById / setSelected / …
2. 钩上列出UI
核心 NormalizedList 编号 : NormalizedSelect 提供 后退视图 用于演示和探索。 关于生产,你更喜欢自己的UI,它与你的设计系统相匹配——见 自定义视图。 。 。 .
import {NormalizedList, useNormalizedList} from '@gravity-ui/normalized-list';
const items = [{data: {title: 'Parent'}, children: [{data: {title: 'Child'}}]}];
export function Example() {
const list = useNormalizedList({items, defaultExpandedState: 'expanded'});
return <NormalizedList list={list} multiple mapItemDataToContentProps={(item) => item} />;
}
3. UIKit 预设
Uikit 条目是一组预设 @gravity-ui/uikit:列表行的命题默认值,选择控件并弹出. 它们涉及“从自己的观点”到“从“从”到“从”到“从“从”到“从”到“从“从”到“从”到“从”到“从“从”到“从”到“从”到“从”到“从”到“从”到“从”到”到”从“从“从”到”到”到”从“从“从”到”到”到“从“从”到”到“从`从”到”到”到“从`从`从`到'到'到'到'从`从`到'到'到'从`从`到'到'到'到'从`从`到'到'到'”的“从`到'到'到'”的“从你自己的观点”的”差距 第2节 对于这个案子,你仍然可以通过道具来推翻.
import {useNormalizedList} from '@gravity-ui/normalized-list';
import {UIKitNormalizedList} from '@gravity-ui/normalized-list/uikit';
export function Example() {
const list = useNormalizedList({
items: ['one', 'two', 'three'],
getItemId: (item) => item,
});
return (
<UIKitNormalizedList list={list} multiple mapItemDataToContentProps={(title) => ({title})} />
);
}
NormalizedSelect 编号 : UIKitNormalizedSelect 内部使用相同的模型(项目 = 正常 = 列表在弹出中).
自定义视图
不重写列表逻辑 :
NormalizedList编号 :NormalizedSelect数字 :renderItem, (中文(简体) ),renderContainerNormalizedSelect页:1renderControl, (中文(简体) ),renderPopup, (中文(简体) ),renderError时段slotBeforeListBody编号 :slotAfterListBody- 用户界面Kit: 互换默认
UIKitListItemView内renderItem, (中文(简体) ),UIKitNormalizedSelectControl一样的方式
<NormalizedList
list={list}
mapItemDataToContentProps={(item) => item}
renderItem={({id, props, context, renderContainerProps}) => (
<MyRow {...props} {...renderContainerProps} isLast={context.isLastItem} />
)}
renderContainer={(containerProps) => <VirtualizedContainer {...containerProps} />}
/>
CSS 命名空间
BEM 根和包 CSS 变量使用 g-nl- 前缀( 例如) --g-nl-list-item-background-hover) (中文(简体) ).
UIKit 条目将变量映射到 @gravity-ui/uikit 指针( a)--g-color-*, (中文(简体) ), --g-spacing-*(中文(简体) ).
故事书
实例 常规列表 (核心)和 已规范列表/ UIKit医生是 *Docs.md 每个故事本条目旁边.
许可证
麻省理工学院