List
List is a component for displaying lists. By default, it renders a ul element.
- ăä¸ă¤ăăăŽä¸çăŤăăăăăăă掺ĺˇăćŚäşăçĽĺĽŞăçŚăă
- ăäşă¤ăäşăăŻĺ ¨ăŚă˛ăźă ăŤăăăĺćă§č§ŁćąşăăăăŽă¨ăă
- ăä¸ă¤ăă˛ăźă ăŤăŻăç¸äşă寞çă¨ĺ¤ćăăăăŽăčłăăŚčĄăăă
- ăĺă¤ă "ä¸"ăŤĺăăŞăéăăă˛ăźă ĺ 厚ăčłăăăăŽăŻä¸ĺăĺăăŞă
- ăäşă¤ăă˛ăźă ĺ 厚ăŻăćăžăăćšăćąşĺŽć¨Šăćăă
- ăĺ ă¤ă"çç´ăŤčŞăŁăŚ"čĄăăăčłăăŻă羜寞éľĺŽăăă
- ăä¸ă¤ăéĺŁăŤăăăäşăăŻăĺ ¨ć¨ŠäťŁçč ăăăŚăăăŽă¨ăă
- ăĺ Ťă¤ăă˛ăźă ä¸ăŽä¸ćŁçşčŚăŻăćĺă¨čŚăŞă
- ăäšă¤ă䝼ä¸ăăăŁăŚçĽăŽĺăŽăă¨çľśĺŻžä¸ĺ¤ăŽăŤăźăŤă¨ăă
- ăĺăăżăăŞăŞăăăăăŹă¤ăăžăăă
<List.Root>
<List.Item>
ăä¸ă¤ăăăŽä¸çăŤăăăăăăă掺ĺˇăćŚäşăçĽĺĽŞăçŚăă
</List.Item>
<List.Item>
ăäşă¤ăäşăăŻĺ
¨ăŚă˛ăźă ăŤăăăĺćă§č§ŁćąşăăăăŽă¨ăă
</List.Item>
<List.Item>
ăä¸ă¤ăă˛ăźă ăŤăŻăç¸äşă寞çă¨ĺ¤ćăăăăŽăčłăăŚčĄăăă
</List.Item>
<List.Item>
ăĺă¤ă "ä¸"ăŤĺăăŞăéăăă˛ăźă ĺ
厚ăčłăăăăŽăŻä¸ĺăĺăăŞă
</List.Item>
<List.Item>ăäşă¤ăă˛ăźă ĺ
厚ăŻăćăžăăćšăćąşĺŽć¨Šăćăă</List.Item>
<List.Item>ăĺ
ă¤ă"çç´ăŤčŞăŁăŚ"čĄăăăčłăăŻă羜寞éľĺŽăăă</List.Item>
<List.Item>
ăä¸ă¤ăéĺŁăŤăăăäşăăŻăĺ
¨ć¨ŠäťŁçč
ăăăŚăăăŽă¨ăă
</List.Item>
<List.Item>ăĺ
Ťă¤ăă˛ăźă ä¸ăŽä¸ćŁçşčŚăŻăćĺă¨čŚăŞă</List.Item>
<List.Item>ăäšă¤ă䝼ä¸ăăăŁăŚçĽăŽĺăŽăă¨çľśĺŻžä¸ĺ¤ăŽăŤăźăŤă¨ăă</List.Item>
<List.Item>ăĺăăżăăŞăŞăăăăăŹă¤ăăžăăă</List.Item>
</List.Root>
Usage
import { List } from "@yamada-ui/react"
import { List } from "@/components/ui"
import { List } from "@workspaces/ui"
<List.Root>
<List.Item>
<List.Icon />
</List.Item>
</List.Root>
Use items
- ăä¸ă¤ăăăŽä¸çăŤăăăăăăă掺ĺˇăćŚäşăçĽĺĽŞăçŚăă
- ăäşă¤ăäşăăŻĺ ¨ăŚă˛ăźă ăŤăăăĺćă§č§ŁćąşăăăăŽă¨ăă
- ăä¸ă¤ăă˛ăźă ăŤăŻăç¸äşă寞çă¨ĺ¤ćăăăăŽăčłăăŚčĄăăă
- ăĺă¤ă "ä¸"ăŤĺăăŞăéăăă˛ăźă ĺ 厚ăčłăăăăŽăŻä¸ĺăĺăăŞă
- ăäşă¤ăă˛ăźă ĺ 厚ăŻăćăžăăćšăćąşĺŽć¨Šăćăă
- ăĺ ă¤ă"çç´ăŤčŞăŁăŚ"čĄăăăčłăăŻă羜寞éľĺŽăăă
- ăä¸ă¤ăéĺŁăŤăăăäşăăŻăĺ ¨ć¨ŠäťŁçč ăăăŚăăăŽă¨ăă
- ăĺ Ťă¤ăă˛ăźă ä¸ăŽä¸ćŁçşčŚăŻăćĺă¨čŚăŞă
- ăäšă¤ă䝼ä¸ăăăŁăŚçĽăŽĺăŽăă¨çľśĺŻžä¸ĺ¤ăŽăŤăźăŤă¨ăă
- ăĺăăżăăŞăŞăăăăăŹă¤ăăžăăă
const items = useMemo<List.Item[]>(
() => [
{ children: "ăä¸ă¤ăăăŽä¸çăŤăăăăăăă掺ĺˇăćŚäşăçĽĺĽŞăçŚăă" },
{ children: "ăäşă¤ăäşăăŻĺ
¨ăŚă˛ăźă ăŤăăăĺćă§č§ŁćąşăăăăŽă¨ăă" },
{
children: "ăä¸ă¤ăă˛ăźă ăŤăŻăç¸äşă寞çă¨ĺ¤ćăăăăŽăčłăăŚčĄăăă",
},
{
children:
'ăĺă¤ă "ä¸"ăŤĺăăŞăéăăă˛ăźă ĺ
厚ăčłăăăăŽăŻä¸ĺăĺăăŞă',
},
{ children: "ăäşă¤ăă˛ăźă ĺ
厚ăŻăćăžăăćšăćąşĺŽć¨Šăćăă" },
{ children: 'ăĺ
ă¤ă"çç´ăŤčŞăŁăŚ"čĄăăăčłăăŻă羜寞éľĺŽăăă' },
{ children: "ăä¸ă¤ăéĺŁăŤăăăäşăăŻăĺ
¨ć¨ŠäťŁçč
ăăăŚăăăŽă¨ăă" },
{ children: "ăĺ
Ťă¤ăă˛ăźă ä¸ăŽä¸ćŁçşčŚăŻăćĺă¨čŚăŞă" },
{ children: "ăäšă¤ă䝼ä¸ăăăŁăŚçĽăŽĺăŽăă¨çľśĺŻžä¸ĺ¤ăŽăŤăźăŤă¨ăă" },
{ children: "ăĺăăżăăŞăŞăăăăăŹă¤ăăžăăă" },
],
[],
)
return <List.Root items={items} />
Use Marker
- ăä¸ă¤ăăăŽä¸çăŤăăăăăăă掺ĺˇăćŚäşăçĽĺĽŞăçŚăă
- ăäşă¤ăäşăăŻĺ ¨ăŚă˛ăźă ăŤăăăĺćă§č§ŁćąşăăăăŽă¨ăă
- ăä¸ă¤ăă˛ăźă ăŤăŻăç¸äşă寞çă¨ĺ¤ćăăăăŽăčłăăŚčĄăăă
- ăĺă¤ă "ä¸"ăŤĺăăŞăéăăă˛ăźă ĺ 厚ăčłăăăăŽăŻä¸ĺăĺăăŞă
- ăä¸ă¤ăăăŽä¸çăŤăăăăăăă掺ĺˇăćŚäşăçĽĺĽŞăçŚăă
- ăäşă¤ăäşăăŻĺ ¨ăŚă˛ăźă ăŤăăăĺćă§č§ŁćąşăăăăŽă¨ăă
- ăä¸ă¤ăă˛ăźă ăŤăŻăç¸äşă寞çă¨ĺ¤ćăăăăŽăčłăăŚčĄăăă
- ăĺă¤ă "ä¸"ăŤĺăăŞăéăăă˛ăźă ĺ 厚ăčłăăăăŽăŻä¸ĺăĺăăŞă
- ăä¸ă¤ăăăŽä¸çăŤăăăăăăă掺ĺˇăćŚäşăçĽĺĽŞăçŚăă
- ăäşă¤ăäşăăŻĺ ¨ăŚă˛ăźă ăŤăăăĺćă§č§ŁćąşăăăăŽă¨ăă
- ăä¸ă¤ăă˛ăźă ăŤăŻăç¸äşă寞çă¨ĺ¤ćăăăăŽăčłăăŚčĄăăă
- ăĺă¤ă "ä¸"ăŤĺăăŞăéăăă˛ăźă ĺ 厚ăčłăăăăŽăŻä¸ĺăĺăăŞă
- ăä¸ă¤ăăăŽä¸çăŤăăăăăăă掺ĺˇăćŚäşăçĽĺĽŞăçŚăă
- ăäşă¤ăäşăăŻĺ ¨ăŚă˛ăźă ăŤăăăĺćă§č§ŁćąşăăăăŽă¨ăă
- ăä¸ă¤ăă˛ăźă ăŤăŻăç¸äşă寞çă¨ĺ¤ćăăăăŽăčłăăŚčĄăăă
- ăĺă¤ă "ä¸"ăŤĺăăŞăéăăă˛ăźă ĺ 厚ăčłăăăăŽăŻä¸ĺăĺăăŞă
- ăä¸ă¤ăăăŽä¸çăŤăăăăăăă掺ĺˇăćŚäşăçĽĺĽŞăçŚăă
- ăäşă¤ăäşăăŻĺ ¨ăŚă˛ăźă ăŤăăăĺćă§č§ŁćąşăăăăŽă¨ăă
- ăä¸ă¤ăă˛ăźă ăŤăŻăç¸äşă寞çă¨ĺ¤ćăăăăŽăčłăăŚčĄăăă
- ăĺă¤ă "ä¸"ăŤĺăăŞăéăăă˛ăźă ĺ 厚ăčłăăăăŽăŻä¸ĺăĺăăŞă
<VStack>
<For each={["disc", "decimal", "square", "circle", "lower-alpha"]}>
{(styleType, index) => (
<List.Root key={index} styleType={styleType}>
<List.Item>
ăä¸ă¤ăăăŽä¸çăŤăăăăăăă掺ĺˇăćŚäşăçĽĺĽŞăçŚăă
</List.Item>
<List.Item>
ăäşă¤ăäşăăŻĺ
¨ăŚă˛ăźă ăŤăăăĺćă§č§ŁćąşăăăăŽă¨ăă
</List.Item>
<List.Item>
ăä¸ă¤ăă˛ăźă ăŤăŻăç¸äşă寞çă¨ĺ¤ćăăăăŽăčłăăŚčĄăăă
</List.Item>
<List.Item>
ăĺă¤ă "ä¸"ăŤĺăăŞăéăăă˛ăźă ĺ
厚ăčłăăăăŽăŻä¸ĺăĺăăŞă
</List.Item>
</List.Root>
)}
</For>
</VStack>
Using Custom Icons
To use custom icons for items, set a ReactNode to the icon property or use List.Icon.
- ăä¸ă¤ăăăŽä¸çăŤăăăăăăă掺ĺˇăćŚäşăçĽĺĽŞăçŚăă
- ăäşă¤ăäşăăŻĺ ¨ăŚă˛ăźă ăŤăăăĺćă§č§ŁćąşăăăăŽă¨ăă
- ăä¸ă¤ăă˛ăźă ăŤăŻăç¸äşă寞çă¨ĺ¤ćăăăăŽăčłăăŚčĄăăă
- ăĺă¤ă "ä¸"ăŤĺăăŞăéăăă˛ăźă ĺ 厚ăčłăăăăŽăŻä¸ĺăĺăăŞă
- ăäşă¤ăă˛ăźă ĺ 厚ăŻăćăžăăćšăćąşĺŽć¨Šăćăă
- ăĺ ă¤ă"çç´ăŤčŞăŁăŚ"čĄăăăčłăăŻă羜寞éľĺŽăăă
- ăä¸ă¤ăéĺŁăŤăăăäşăăŻăĺ ¨ć¨ŠäťŁçč ăăăŚăăăŽă¨ăă
- ăĺ Ťă¤ăă˛ăźă ä¸ăŽä¸ćŁçşčŚăŻăćĺă¨čŚăŞă
- ăäšă¤ă䝼ä¸ăăăŁăŚçĽăŽĺăŽăă¨çľśĺŻžä¸ĺ¤ăŽăŤăźăŤă¨ăă
- ăĺăăżăăŞăŞăăăăăŹă¤ăăžăăă
const items = useMemo<List.Item[]>(
() => [
{
icon: <CircleCheckIcon color="success" />,
children: "ăä¸ă¤ăăăŽä¸çăŤăăăăăăă掺ĺˇăćŚäşăçĽĺĽŞăçŚăă",
},
{
icon: <CircleCheckIcon color="success" />,
children: "ăäşă¤ăäşăăŻĺ
¨ăŚă˛ăźă ăŤăăăĺćă§č§ŁćąşăăăăŽă¨ăă",
},
{
icon: <LoaderIcon color="fg.subtle" />,
children: "ăä¸ă¤ăă˛ăźă ăŤăŻăç¸äşă寞çă¨ĺ¤ćăăăăŽăčłăăŚčĄăăă",
},
],
[],
)
return (
<VStack>
<List.Root items={items} />
<List.Root>
<List.Item icon={<CircleCheckIcon color="success" />}>
ăĺă¤ă "ä¸"ăŤĺăăŞăéăăă˛ăźă ĺ
厚ăčłăăăăŽăŻä¸ĺăĺăăŞă
</List.Item>
<List.Item icon={<CircleCheckIcon color="success" />}>
ăäşă¤ăă˛ăźă ĺ
厚ăŻăćăžăăćšăćąşĺŽć¨Šăćăă
</List.Item>
<List.Item icon={<LoaderIcon color="fg.subtle" />}>
ăĺ
ă¤ă"çç´ăŤčŞăŁăŚ"čĄăăăčłăăŻă羜寞éľĺŽăăă
</List.Item>
</List.Root>
<List.Root>
<List.Item>
<List.Icon>
<CircleCheckIcon color="success" />
</List.Icon>
ăä¸ă¤ăéĺŁăŤăăăäşăăŻăĺ
¨ć¨ŠäťŁçč
ăăăŚăăăŽă¨ăă
</List.Item>
<List.Item>
<List.Icon>
<CircleCheckIcon color="success" />
</List.Icon>
ăĺ
Ťă¤ăă˛ăźă ä¸ăŽä¸ćŁçşčŚăŻăćĺă¨čŚăŞă
</List.Item>
<List.Item>
<List.Icon>
<CircleCheckIcon color="success" />
</List.Icon>
ăäšă¤ă䝼ä¸ăăăŁăŚçĽăŽĺăŽăă¨çľśĺŻžä¸ĺ¤ăŽăŤăźăŤă¨ăă
</List.Item>
<List.Item>
<List.Icon>
<LoaderIcon color="fg.subtle" />
</List.Icon>
ăĺăăżăăŞăŞăăăăăŹă¤ăăžăăă
</List.Item>
</List.Root>
</VStack>
)
Props
Similar Components
DataList
DataList is used to display a list of data items.
Timeline
Timeline is a component that is used to display a list of events in chronological order.
Tree
Tree is a component used to display hierarchical data structures in an expandable tree format.
NativeTable
NativeTable is a component for efficiently organizing and displaying data.
Stat
Stat is used to display numbers or data within a box.
Table
Table is a table component equipped with column sorting, row selection, and click event features.
AreaChart
AreaChart is a component for drawing area charts to compare multiple sets of data.
Badge
Badge is a component that emphasizes the status of an item to make it immediately recognizable.