carbon-components-svelte/types/UIShell/SideNavMenu.svelte.d.ts
Eric Liu 6bf72d4602
fix(types): loosen icon prop type to any (#2095)
Fixes 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.
2025-02-02 19:49:53 -08:00

40 lines
819 B
TypeScript

import type { SvelteComponentTyped } from "svelte";
import type { SvelteHTMLElements } from "svelte/elements";
type $RestProps = SvelteHTMLElements["button"];
type $Props = {
/**
* Set to `true` to toggle the expanded state
* @default false
*/
expanded?: boolean;
/**
* Specify the text
* @default undefined
*/
text?: string;
/**
* Specify the icon to render
* @default undefined
*/
icon?: any;
/**
* Obtain a reference to the HTML button element
* @default null
*/
ref?: null | HTMLButtonElement;
[key: `data-${string}`]: any;
};
export type SideNavMenuProps = Omit<$RestProps, keyof $Props> & $Props;
export default class SideNavMenu extends SvelteComponentTyped<
SideNavMenuProps,
{ click: WindowEventMap["click"] },
{ default: {}; icon: {} }
> {}