mirror of
https://github.com/carbon-design-system/carbon-components-svelte.git
synced 2025-09-15 10:21:05 +00:00
5576c7ce84* fix(header-action): type missing "open" event * Run "yarn build:docs" * test(header-utilities): assert "open" and "close" events
55 lines
1.4 KiB
TypeScript
55 lines
1.4 KiB
TypeScript
/// <reference types="svelte" />
|
|
import type { SvelteComponentTyped } from "svelte";
|
|
|
|
export interface HeaderActionProps
|
|
extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["button"]> {
|
|
/**
|
|
* Set to `true` to open the panel
|
|
* @default false
|
|
*/
|
|
isOpen?: boolean;
|
|
|
|
/**
|
|
* Specify the icon to render when the action panel is closed.
|
|
* Defaults to `<Switcher size={20} />`
|
|
* @default undefined
|
|
*/
|
|
icon?: typeof import("svelte").SvelteComponent;
|
|
|
|
/**
|
|
* Specify the icon to render when the action panel is open.
|
|
* Defaults to `<Close size={20} />`
|
|
* @default undefined
|
|
*/
|
|
closeIcon?: typeof import("svelte").SvelteComponent;
|
|
|
|
/**
|
|
* Specify the text
|
|
* Alternatively, use the named slot "text" (e.g., <div slot="text">...</div>)
|
|
* @default undefined
|
|
*/
|
|
text?: string;
|
|
|
|
/**
|
|
* Obtain a reference to the button HTML element
|
|
* @default null
|
|
*/
|
|
ref?: null | HTMLButtonElement;
|
|
|
|
/**
|
|
* Customize the panel transition (i.e., `transition:slide`).
|
|
* Set to `false` to disable the transition
|
|
* @default { duration: 200 }
|
|
*/
|
|
transition?: false | import("svelte/transition").SlideParams;
|
|
}
|
|
|
|
export default class HeaderAction extends SvelteComponentTyped<
|
|
HeaderActionProps,
|
|
{
|
|
open: CustomEvent<null>;
|
|
close: CustomEvent<null>;
|
|
click: WindowEventMap["click"];
|
|
},
|
|
{ default: {}; closeIcon: {}; icon: {}; text: {} }
|
|
> {}
|