Skip to content

Commit de7ce4e

Browse files
committed
removed ListProvider docs and updated ListRow mdx file
1 parent eac88ed commit de7ce4e

5 files changed

Lines changed: 9 additions & 84 deletions

File tree

packages/styleguide/src/lib/Organisms/Lists & Tables/List/About.mdx

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ import {
88

99
import { parameters as listParameters } from './List.mdx';
1010
import { parameters as listColParameters } from './ListCol/ListCol.mdx';
11-
import { parameters as listProviderParameters } from './ListProvider/ListProvider.mdx';
1211
import { parameters as listRowParameters } from './ListRow/ListRow.mdx';
1312
import { parameters as tableHeaderParameters } from './TableHeader/TableHeader.mdx';
1413

@@ -23,12 +22,11 @@ export const parameters = {
2322

2423
<AboutHeader {...parameters} />
2524

26-
Use `List` as the root container, with `ListRow` and `ListCol` defining each row and column. For table layouts (`as="table"`), add `TableHeader` for a header row. Context from `ListProvider` (provided by `List`) drives spacing, variant, and responsive behavior—see `ListProvider` for hooks and advanced usage.
25+
Use `List` as the root container, with `ListRow` and `ListCol` defining each row and column. For table layouts (`as="table"`), add `TableHeader` for a header row. `List` wraps its subtree in `ListProvider` so rows, columns, and the header share spacing, variant, and responsive layout context.
2726

2827
<TableOfContents
2928
links={addParentPath(parameters.id, [
3029
listParameters,
31-
listProviderParameters,
3230
listRowParameters,
3331
listColParameters,
3432
tableHeaderParameters,

packages/styleguide/src/lib/Organisms/Lists & Tables/List/List.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,7 @@ export const parameters = {
3232

3333
### Components
3434

35-
- `List`: Root list or table wrapper; sets spacing, variant, `as` (`ul` | `ol` | `table`), scrollable layout, and container-query behavior.
36-
- `ListProvider`: Supplied by `List`; use <LinkTo id="Organisms/Lists & Tables/List/ListProvider">ListProvider</LinkTo> for `useListContext` / `useList` when building custom list internals.
35+
- `List`: Root list or table wrapper; sets spacing, variant, `as` (`ul` | `ol` | `table`), scrollable layout, and container-query behavior. It wraps children in `ListProvider` so `ListRow`, `ListCol`, and `TableHeader` share layout context (`useListContext` for advanced list internals; prefer `List` props over the internal `useList` hook).
3736
- `ListRow`: One logical row; supports expandable content. See <LinkTo id="Organisms/Lists & Tables/List/ListRow">ListRow</LinkTo>.
3837
- `ListCol`: Column cell with sizing, `type`, and justification. See <LinkTo id="Organisms/Lists & Tables/List/ListCol">ListCol</LinkTo>.
3938
- `TableHeader`: Sticky header row for `as="table"`. See <LinkTo id="Organisms/Lists & Tables/List/TableHeader">TableHeader</LinkTo>.

packages/styleguide/src/lib/Organisms/Lists & Tables/List/ListProvider/ListProvider.mdx

Lines changed: 0 additions & 49 deletions
This file was deleted.

packages/styleguide/src/lib/Organisms/Lists & Tables/List/ListProvider/ListProvider.stories.tsx

Lines changed: 0 additions & 23 deletions
This file was deleted.

packages/styleguide/src/lib/Organisms/Lists & Tables/List/ListRow/ListRow.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,35 +22,35 @@ export const parameters = {
2222

2323
## Usage
2424

25-
`ListRow` renders one logical row. It reads spacing, variant, and layout from `List` via `ListProvider`. Compose rows with <LinkTo id="Organisms/Lists & Tables/List/ListCol">ListCol</LinkTo> children.
25+
`ListRow` renders a single row. It receives spacing, variant, and layout from `List`. Compose each row with <LinkTo id="Organisms/Lists & Tables/List/ListCol">ListCol</LinkTo> children.
2626

27-
For table layouts (`List` with `as="table"`), body rows still use `ListRow`. Header labels belong in <LinkTo id="Organisms/Lists & Tables/List/TableHeader">TableHeader</LinkTo> with `ListCol` cells—see <LinkTo id="Organisms/Lists & Tables/List/ListCol">ListCol</LinkTo> (Header columns).
27+
For table layouts (`List` with `as="table"`), the rows still use `ListRow`. However, the header row should use <LinkTo id="Organisms/Lists & Tables/List/TableHeader">TableHeader</LinkTo>.
2828

2929
### Plain variant styling
3030

31-
When the parent `List` uses `variant="plain"`, you can still style individual rows (for example with Emotion `styled`) to emphasize or group items.
31+
As noted in <LinkTo id="Organisms/Lists & Tables/List/List">List</LinkTo>, when the parent `List` uses `variant="plain"`, style individual `ListRow` components using Emotion's `styled` function to emphasize or group items.
3232

3333
<Canvas of={ListRowStories.PlainStyled} />
3434

3535
## Expandable rows
3636

37-
You can define collapsible content by passing an `expanded` prop and a `renderExpanded` callback that returns the expanded region.
37+
Define collapsible content with an `expanded` prop and a `renderExpanded` callback that returns the expanded region.
3838

3939
### Expand on button click
4040

41-
The `ListRow` can include `ExpandControl` in a `ListCol` with `type="control"` to toggle expansion. `ExpandControl` rotates its icon based on `expanded`.
41+
Include `ExpandControl` in a `ListCol` with `type="control"` to toggle expansion. `ExpandControl` rotates its icon based on `expanded`.
4242

4343
<Canvas of={ListRowStories.ExpandableButtonGuide} />
4444

4545
### Expand on row click
4646

47-
An entire row can toggle expansion via `onClick` on `ListRow` (non-table lists).
47+
When `List` does not use `as="table"`, use `onClick` on `ListRow` so the whole row toggles expansion.
4848

4949
<Canvas of={ListRowStories.ExpandedRowGuide} />
5050

5151
## Playground
5252

53-
For full `List` props and variants, see <LinkTo id="Organisms/Lists & Tables/List/List">List</LinkTo>.
53+
Adjust `ListRow` on the expandable example. For `List` props and variants, see <LinkTo id="Organisms/Lists & Tables/List/List">List</LinkTo>.
5454

5555
<Canvas sourceState="shown" of={ListRowStories.ExpandableButtonGuide} />
5656

0 commit comments

Comments
 (0)