Skip to content

fix: Fix list renderItem typings #4388

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gethinwebster merged 1 commit into from
Mar 27, 2026
+6 −6
Merged

fix: Fix list renderItem typings #4388

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions src/__tests__/snapshot-tests/__snapshots__/documenter.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16821,23 +16821,23 @@ exports[`Components definition for list matches the snapshot: list 1`] = `
* \`content\` (React.ReactNode) - The content of the item.
* \`secondaryContent\` (React.ReactNode) - (Optional) Secondary content, for example item description.
* \`icon\` (React.ReactNode) - (Optional) An icon, displayed at the start.
* \`action\` (React.ReactNode) - (Optional) Action button(s).
* \`actions\` (React.ReactNode) - (Optional) Action button(s).
* \`announcementLabel\` (string) - (Optional) An announcement label for the item, used when sorting.
By default, the \`content\` is used: a custom label should be provided if \`content\` is not a string.",
"inlineType": {
"name": "(item: T) => { id: string; content: React.ReactNode; secondaryContent?: React.ReactNode; icon?: React.ReactNode; action?: React.ReactNode; announcementLabel?: string | undefined; }",
"name": "(item: T) => { id: string; content: React.ReactNode; secondaryContent?: React.ReactNode; icon?: React.ReactNode; actions?: React.ReactNode; announcementLabel?: string | undefined; }",
"parameters": [
{
"name": "item",
"type": "T",
},
],
"returnType": "{ id: string; content: React.ReactNode; secondaryContent?: React.ReactNode; icon?: React.ReactNode; action?: React.ReactNode; announcementLabel?: string | undefined; }",
"returnType": "{ id: string; content: React.ReactNode; secondaryContent?: React.ReactNode; icon?: React.ReactNode; actions?: React.ReactNode; announcementLabel?: string | undefined; }",
"type": "function",
},
"name": "renderItem",
"optional": false,
"type": "(item: T) => { id: string; content: React.ReactNode; secondaryContent?: React.ReactNode; icon?: React.ReactNode; action?: React.ReactNode; announcementLabel?: string | undefined; }",
"type": "(item: T) => { id: string; content: React.ReactNode; secondaryContent?: React.ReactNode; icon?: React.ReactNode; actions?: React.ReactNode; announcementLabel?: string | undefined; }",
},
{
"description": "Makes the list sortable by enabling drag and drop functionality.",
Expand Down
4 changes: 2 additions & 2 deletions src/list/interfaces.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export interface ListProps<T = any> {
* * `content` (React.ReactNode) - The content of the item.
* * `secondaryContent` (React.ReactNode) - (Optional) Secondary content, for example item description.
* * `icon` (React.ReactNode) - (Optional) An icon, displayed at the start.
* * `action` (React.ReactNode) - (Optional) Action button(s).
* * `actions` (React.ReactNode) - (Optional) Action button(s).
* * `announcementLabel` (string) - (Optional) An announcement label for the item, used when sorting.
* By default, the `content` is used: a custom label should be provided if `content` is not a string.
*/
Expand All @@ -27,7 +27,7 @@ export interface ListProps<T = any> {
content: ReactNode;
secondaryContent?: ReactNode;
icon?: ReactNode;
action?: ReactNode;
actions?: ReactNode;
announcementLabel?: string;
};

Expand Down
Loading