Skip to content

Commit 9bd457a

Browse files
committed
fix: update clipboardManagerProps
1 parent 7e1e1de commit 9bd457a

File tree

1 file changed

+49
-25
lines changed

1 file changed

+49
-25
lines changed

src/routes/docs-examples/extend/clipboard-manager/clipboardManagerProps.ts

Lines changed: 49 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -9,96 +9,120 @@ export const clipboardManagerProps = [
99
prop: "placeholder",
1010
type: "string",
1111
default: '"Type and save to clipboard"',
12-
description: "Input placeholder"
12+
description: "Input placeholder text"
1313
},
1414
{
1515
prop: "saveLabel",
1616
type: "string",
1717
default: '"Save"',
18-
description: "Save button label"
18+
description: "Label for the save button"
1919
},
2020
{
2121
prop: "clearLabel",
2222
type: "string",
2323
default: '"Clear All"',
24-
description: "Clear button label"
24+
description: "Label for the clear all button"
2525
},
2626
{
2727
prop: "limit",
2828
type: "number",
2929
default: "20",
30-
description: "Max items to store"
30+
description: "Maximum number of clipboard items to store"
3131
},
3232
{
3333
prop: "saveToStorage",
3434
type: "boolean",
3535
default: "true",
36-
description: "Persist items to localStorage"
36+
description: "Whether to persist clipboard items to localStorage"
3737
},
3838
{
3939
prop: "toastDuration",
4040
type: "number",
4141
default: "2000",
42-
description: "Toast duration (ms)"
42+
description: "Duration in milliseconds to show toast notifications"
4343
},
4444
{
4545
prop: "filterSensitive",
4646
type: "boolean",
4747
default: "true",
48-
description: "Block sensitive data"
48+
description: "Whether to filter out sensitive data (credit cards, passwords, etc.)"
4949
},
5050
{
5151
prop: "maxLength",
5252
type: "number",
5353
default: "10000",
54-
description: "Max chars per item"
54+
description: "Maximum character length for clipboard items"
5555
},
5656
{
5757
prop: "enableSelectionMenu",
5858
type: "boolean",
5959
default: "false",
60-
description: "Show selection bubble"
60+
description: "Enable text selection menu for saving selected text"
6161
},
6262
{
6363
prop: "selectionTarget",
6464
type: "string",
6565
default: '"body"',
66-
description: "Selection menu target"
66+
description: "CSS selector for elements where selection menu should be enabled"
6767
},
6868
{
6969
prop: "showInput",
7070
type: "boolean",
7171
default: "true",
72-
description: "Show input field"
72+
description: "Whether to show the input field for adding new clipboard items"
7373
},
7474
{
7575
prop: "class",
76-
type: "string",
76+
type: "ClassValue",
7777
default: '""',
78-
description: "Additional classes"
78+
description: "Additional CSS classes for the component container"
79+
},
80+
{
81+
prop: "classes",
82+
type: "ClipboardManagerVariants",
83+
default: "undefined",
84+
description: "Object containing CSS classes for component parts"
7985
},
8086
{
8187
prop: "storageKey",
82-
type: "string | undefined",
88+
type: "string",
8389
default: "undefined",
84-
description: "localStorage key"
90+
description: "Custom localStorage key (defaults to 'flowbite-clipboard-manager')"
8591
},
8692
{
87-
prop: "children",
88-
type: "Snippet | undefined",
93+
prop: "open",
94+
type: "boolean",
95+
default: "undefined",
96+
description: "Control modal state. If undefined, renders inline; if defined, renders as modal"
97+
},
98+
{
99+
prop: "badgeProps",
100+
type: "Omit<BadgeProps, 'children'>",
101+
default: "{ color: 'blue', class: 'text-xs' }",
102+
description: "Props to pass to the pinned badge component"
103+
},
104+
{
105+
prop: "modalProps",
106+
type: "ModalProps",
89107
default: "undefined",
90-
description: "Custom item renderer"
108+
description: "Props to pass to the modal component when rendering as modal"
91109
},
92110
{
93-
prop: "empty",
94-
type: "Snippet | undefined",
111+
prop: "detectSensitiveData",
112+
type: "(text: string) => boolean",
95113
default: "undefined",
96-
description: "Custom empty state"
114+
description: "Custom function to detect sensitive data. Overrides default detection"
97115
},
98116
{
99-
prop: "open",
100-
type: "boolean | undefined",
117+
prop: "children",
118+
type: "Snippet",
119+
default: "undefined",
120+
description: "Custom render function for clipboard items. Receives item, copyItem, deleteItem, and togglePin"
121+
},
122+
{
123+
prop: "emptyState",
124+
type: "Snippet",
101125
default: "undefined",
102-
description: "Modal state (bindable)"
126+
description: "Custom render function for the empty state"
103127
}
104-
]
128+
];

0 commit comments

Comments
 (0)