feat(context-menu): annotate props, generate types

This commit is contained in:
Eric Y Liu 2021-03-19 13:42:15 -07:00
commit 2ff4d43292
11 changed files with 582 additions and 19 deletions

40
types/ContextMenu/ContextMenu.d.ts vendored Normal file
View file

@ -0,0 +1,40 @@
/// <reference types="svelte" />
import { SvelteComponentTyped } from "svelte";
export interface ContextMenuProps
extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["ul"]> {
/**
* Set to `true` to open the menu
* Either `x` and `y` must be greater than zero
* @default false
*/
open?: boolean;
/**
* Specify the horizontal offset of the menu position
* @default 0
*/
x?: number;
/**
* Specify the vertical offset of the menu position
* @default 0
*/
y?: number;
/**
* Obtain a reference to the unordered list HTML element
* @default null
*/
ref?: null | HTMLUListElement;
}
export default class ContextMenu extends SvelteComponentTyped<
ContextMenuProps,
{
click: WindowEventMap["click"];
keydown: WindowEventMap["keydown"];
close: CustomEvent<any>;
},
{ default: {} }
> {}

View file

@ -0,0 +1,10 @@
/// <reference types="svelte" />
import { SvelteComponentTyped } from "svelte";
export interface ContextMenuDividerProps {}
export default class ContextMenuDivider extends SvelteComponentTyped<
ContextMenuDividerProps,
{},
{}
> {}

21
types/ContextMenu/ContextMenuGroup.d.ts vendored Normal file
View file

@ -0,0 +1,21 @@
/// <reference types="svelte" />
import { SvelteComponentTyped } from "svelte";
export interface ContextMenuGroupProps {
/**
* @default []
*/
selectedIds?: string[];
/**
* Specify the label text
* @default ""
*/
labelText?: string;
}
export default class ContextMenuGroup extends SvelteComponentTyped<
ContextMenuGroupProps,
{},
{ default: {} }
> {}

View file

@ -0,0 +1,74 @@
/// <reference types="svelte" />
import { SvelteComponentTyped } from "svelte";
export interface ContextMenuOptionProps
extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["li"]> {
/**
* Set to `true` to enable the disabled state
* @default false
*/
disabled?: boolean;
/**
* Set to `true` to indent the label
* @default false
*/
indented?: boolean;
/**
* Specify the icon from `carbon-icons-svelte` to render
* Icon is rendered to the left of the label text
*/
icon?: typeof import("carbon-icons-svelte").CarbonIcon;
/**
* Specify the label text
* Alternatively, use the "labelText" slot (e.g., <span slot="labelText">...</span>)
* @default ""
*/
labelText?: string;
/**
* Set to `true` to use the selected variant
* @default false
*/
selected?: boolean;
/**
* Set to `true` to enable the selectable variant
* Automatically set to `true` if `selected` is `true`
* @default false
*/
selectable?: boolean;
/**
* Specify the shortcut text
* Alternatively, use the "shortcutText" slot (e.g., <span slot="shortcutText">...</span>)
* @default ""
*/
shortcutText?: string;
/**
* Specify the id
* It's highly recommended to provide an id when using in a selectable/radio menu group
* @default "ccs-" + Math.random().toString(36)
*/
id?: string;
/**
* Obtain a reference to the list item HTML element
* @default null
*/
ref?: null | HTMLLIElement;
}
export default class ContextMenuOption extends SvelteComponentTyped<
ContextMenuOptionProps,
{
keydown: WindowEventMap["keydown"];
mouseenter: WindowEventMap["mouseenter"];
mouseleave: WindowEventMap["mouseleave"];
click: CustomEvent<any>;
},
{ default: {}; labelText: {}; shortcutText: {} }
> {}

View file

@ -0,0 +1,22 @@
/// <reference types="svelte" />
import { SvelteComponentTyped } from "svelte";
export interface ContextMenuRadioGroupProps {
/**
* Set the selected radio group id
* @default ""
*/
selectedId?: string;
/**
* Specify the label text
* @default ""
*/
labelText?: string;
}
export default class ContextMenuRadioGroup extends SvelteComponentTyped<
ContextMenuRadioGroupProps,
{},
{ default: {} }
> {}

5
types/index.d.ts vendored
View file

@ -12,6 +12,11 @@ export { default as Checkbox } from "./Checkbox/Checkbox";
export { default as CheckboxSkeleton } from "./Checkbox/CheckboxSkeleton";
export { default as ContentSwitcher } from "./ContentSwitcher/ContentSwitcher";
export { default as Switch } from "./ContentSwitcher/Switch";
export { default as ContextMenu } from "./ContextMenu/ContextMenu";
export { default as ContextMenuDivider } from "./ContextMenu/ContextMenuDivider";
export { default as ContextMenuGroup } from "./ContextMenu/ContextMenuGroup";
export { default as ContextMenuOption } from "./ContextMenu/ContextMenuOption";
export { default as ContextMenuRadioGroup } from "./ContextMenu/ContextMenuRadioGroup";
export { default as Copy } from "./Copy/Copy";
export { default as CopyButton } from "./CopyButton/CopyButton";
export { default as ComboBox } from "./ComboBox/ComboBox";