mirror of
https://github.com/carbon-design-system/carbon-components-svelte.git
synced 2025-09-14 18:01:06 +00:00
6bf72d4602Fixes https://github.com/carbon-design-system/carbon-icons-svelte/issues/207 `carbon-icons-svelte@13` and `carbon-pictograms-svelte@13` now only support TypeScript for Svelte 4/5. The new `Component` type is incompatible with the `icon` prop in `carbon-components-svelte`, causing a type error with Svelte 5, as `typeof SvelteComponent` doesn't match the new `Component` type. Since `Component` isn't available in Svelte 3/4, this PR changes the `icon` prop type to `any` for compatibility across Svelte 3, 4, and 5.
96 lines
2 KiB
TypeScript
96 lines
2 KiB
TypeScript
import type { SvelteComponentTyped } from "svelte";
|
|
import type { SvelteHTMLElements } from "svelte/elements";
|
|
|
|
type $RestProps = SvelteHTMLElements["button"];
|
|
|
|
type $Props = {
|
|
/**
|
|
* Specify the size of the overflow menu
|
|
* @default undefined
|
|
*/
|
|
size?: "sm" | "xl";
|
|
|
|
/**
|
|
* Specify the direction of the overflow menu relative to the button
|
|
* @default "bottom"
|
|
*/
|
|
direction?: "top" | "bottom";
|
|
|
|
/**
|
|
* Set to `true` to open the menu
|
|
* @default false
|
|
*/
|
|
open?: boolean;
|
|
|
|
/**
|
|
* Set to `true` to enable the light variant
|
|
* @default false
|
|
*/
|
|
light?: boolean;
|
|
|
|
/**
|
|
* Set to `true` to flip the menu relative to the button
|
|
* @default false
|
|
*/
|
|
flipped?: boolean;
|
|
|
|
/**
|
|
* Specify the menu options class
|
|
* @default undefined
|
|
*/
|
|
menuOptionsClass?: string;
|
|
|
|
/**
|
|
* Specify the icon to render.
|
|
* Defaults to `<OverflowMenuVertical />`
|
|
* @default undefined
|
|
*/
|
|
icon?: any;
|
|
|
|
/**
|
|
* Specify the icon class
|
|
* @default undefined
|
|
*/
|
|
iconClass?: string;
|
|
|
|
/**
|
|
* Specify the ARIA label for the icon
|
|
* @default "Open and close list of options"
|
|
*/
|
|
iconDescription?: string;
|
|
|
|
/**
|
|
* Set an id for the button element
|
|
* @default "ccs-" + Math.random().toString(36)
|
|
*/
|
|
id?: string;
|
|
|
|
/**
|
|
* Obtain a reference to the trigger button element
|
|
* @default null
|
|
*/
|
|
buttonRef?: null | HTMLButtonElement;
|
|
|
|
/**
|
|
* Obtain a reference to the overflow menu element
|
|
* @default null
|
|
*/
|
|
menuRef?: null | HTMLUListElement;
|
|
|
|
[key: `data-${string}`]: any;
|
|
};
|
|
|
|
export type OverflowMenuProps = Omit<$RestProps, keyof $Props> & $Props;
|
|
|
|
export default class OverflowMenu extends SvelteComponentTyped<
|
|
OverflowMenuProps,
|
|
{
|
|
close: CustomEvent<null | { index: number; text: string }>;
|
|
click: WindowEventMap["click"];
|
|
mouseover: WindowEventMap["mouseover"];
|
|
mouseenter: WindowEventMap["mouseenter"];
|
|
mouseleave: WindowEventMap["mouseleave"];
|
|
keydown: WindowEventMap["keydown"];
|
|
},
|
|
{ default: {}; menu: {} }
|
|
> {}
|