Skip to content

Commit c021089

Browse files
committed
docs: clarify menu README details
1 parent 09bd2ac commit c021089

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ Then open the dumi dev server in your browser.
109109
| motion | `CSSMotionProps` | - | Motion config for menu transitions. |
110110
| multiple | `boolean` | `false` | Allow multiple selected items. |
111111
| openKeys | `string[]` | - | Controlled open sub menu keys. |
112-
| overflowedIndicator | `ReactNode` | `...` | Indicator rendered for overflowed items. |
112+
| overflowedIndicator | `ReactNode` | `"..."` | Indicator rendered for overflowed items. |
113113
| popupRender | `(node, info) => ReactNode` | - | Customize popup menu rendering. |
114114
| prefixCls | `string` | `rc-menu` | Class name prefix. |
115115
| rootClassName | `string` | - | Class name for the root wrapper. |
@@ -130,6 +130,7 @@ Then open the dumi dev server in your browser.
130130
type ItemType =
131131
| {
132132
type?: 'item';
133+
// Item keys accept React.Key and are normalized to strings in event info.
133134
key: React.Key;
134135
label?: React.ReactNode;
135136
disabled?: boolean;
@@ -138,6 +139,7 @@ type ItemType =
138139
}
139140
| {
140141
type?: 'submenu';
142+
// Sub menu keys are strings to match openKeys/defaultOpenKeys.
141143
key: string;
142144
label?: React.ReactNode;
143145
children: ItemType[];

0 commit comments

Comments
 (0)