mirror of
https://github.com/carbon-design-system/carbon-components-svelte.git
synced 2025-09-15 02:11:05 +00:00
57 lines
1.3 KiB
TypeScript
57 lines
1.3 KiB
TypeScript
/// <reference types="svelte" />
|
|
import type { SvelteComponentTyped } from "svelte";
|
|
|
|
export interface SideNavLinkProps
|
|
extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["a"]> {
|
|
/**
|
|
* Set to `true` to select the current link
|
|
* @default false
|
|
*/
|
|
isSelected?: boolean;
|
|
|
|
/**
|
|
* Specify the `href` attribute
|
|
* @default undefined
|
|
*/
|
|
href?: string;
|
|
|
|
/**
|
|
* Specify the text
|
|
* @default undefined
|
|
*/
|
|
text?: string;
|
|
|
|
/**
|
|
* Specify the icon to render
|
|
* @default undefined
|
|
*/
|
|
icon?: typeof import("svelte").SvelteComponent;
|
|
|
|
/**
|
|
* Obtain a reference to the HTML anchor element
|
|
* @default null
|
|
*/
|
|
ref?: null | HTMLAnchorElement;
|
|
|
|
/**
|
|
* SvelteKit attribute to enable data prefetching
|
|
* if a link is hovered over or touched on mobile.
|
|
* @see https://kit.svelte.dev/docs/a-options#sveltekit-prefetch
|
|
* @default false
|
|
*/
|
|
"sveltekit:prefetch"?: boolean;
|
|
|
|
/**
|
|
* SvelteKit attribute to prevent scrolling
|
|
* after the link is clicked.
|
|
* @see https://kit.svelte.dev/docs/a-options#sveltekit-prefetch
|
|
* @default false
|
|
*/
|
|
"sveltekit:noscroll"?: boolean;
|
|
}
|
|
|
|
export default class SideNavLink extends SvelteComponentTyped<
|
|
SideNavLinkProps,
|
|
{ click: WindowEventMap["click"] },
|
|
{ default: {}; icon: {} }
|
|
> {}
|