mirror of
https://github.com/carbon-design-system/carbon-components-svelte.git
synced 2025-09-15 02:11:05 +00:00
refactor(types): shorten ref, id JSDocs, use CarbonIcon type, export component props
This commit is contained in:
parent
d38e6d8be6
commit
75d4b4cf03
219 changed files with 5168 additions and 5259 deletions
114
types/OverflowMenu/OverflowMenuItem.d.ts
vendored
114
types/OverflowMenu/OverflowMenuItem.d.ts
vendored
|
@ -1,62 +1,64 @@
|
|||
/// <reference types="svelte" />
|
||||
|
||||
export interface OverflowMenuItemProps extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["li"]> {
|
||||
/**
|
||||
* Specify the item text
|
||||
* Alternatively, use the default slot for a custom element
|
||||
* @default "Provide text"
|
||||
*/
|
||||
text?: string;
|
||||
|
||||
/**
|
||||
* Specify the `href` attribute if the item is a link
|
||||
* @default ""
|
||||
*/
|
||||
href?: string;
|
||||
|
||||
/**
|
||||
* Set to `true` if the item should be focused when opening the menu
|
||||
* @default false
|
||||
*/
|
||||
primaryFocus?: boolean;
|
||||
|
||||
/**
|
||||
* Set to `true` to disable the item
|
||||
* @default false
|
||||
*/
|
||||
disabled?: boolean;
|
||||
|
||||
/**
|
||||
* Set to `true` to include a divider
|
||||
* @default false
|
||||
*/
|
||||
hasDivider?: boolean;
|
||||
|
||||
/**
|
||||
* Set to `true` to use the danger variant
|
||||
* @default false
|
||||
*/
|
||||
danger?: boolean;
|
||||
|
||||
/**
|
||||
* Set to `false` to omit the button `title` attribute
|
||||
* @default true
|
||||
*/
|
||||
requireTitle?: boolean;
|
||||
|
||||
/**
|
||||
* Set an id for the top-level element
|
||||
* @default "ccs-" + Math.random().toString(36)
|
||||
*/
|
||||
id?: string;
|
||||
|
||||
/**
|
||||
* Obtain a reference to the HTML element
|
||||
* @default null
|
||||
*/
|
||||
ref?: null | HTMLAnchorElement | HTMLButtonElement;
|
||||
}
|
||||
|
||||
export default class OverflowMenuItem {
|
||||
$$prop_def: svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["li"]> & {
|
||||
/**
|
||||
* Specify the item text
|
||||
* Alternatively, use the default slot for a custom element
|
||||
* @default "Provide text"
|
||||
*/
|
||||
text?: string;
|
||||
|
||||
/**
|
||||
* Specify the `href` attribute if the item is a link
|
||||
* @default ""
|
||||
*/
|
||||
href?: string;
|
||||
|
||||
/**
|
||||
* Set to `true` if the item should be focused when opening the menu
|
||||
* @default false
|
||||
*/
|
||||
primaryFocus?: boolean;
|
||||
|
||||
/**
|
||||
* Set to `true` to disable the item
|
||||
* @default false
|
||||
*/
|
||||
disabled?: boolean;
|
||||
|
||||
/**
|
||||
* Set to `true` to include a divider
|
||||
* @default false
|
||||
*/
|
||||
hasDivider?: boolean;
|
||||
|
||||
/**
|
||||
* Set to `true` to use the danger variant
|
||||
* @default false
|
||||
*/
|
||||
danger?: boolean;
|
||||
|
||||
/**
|
||||
* Set to `false` to omit the button `title` attribute
|
||||
* @default true
|
||||
*/
|
||||
requireTitle?: boolean;
|
||||
|
||||
/**
|
||||
* Set an id for the top-level element
|
||||
*/
|
||||
id?: string;
|
||||
|
||||
/**
|
||||
* Obtain a reference to the HTML element
|
||||
* @default null
|
||||
*/
|
||||
ref?: null | HTMLAnchorElement | HTMLButtonElement;
|
||||
};
|
||||
|
||||
$$prop_def: OverflowMenuItemProps;
|
||||
$$slot_def: {
|
||||
default: {};
|
||||
};
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue