TanTan
e311ca3275
Build NapCat Artifacts / Windows Loader Test (push) Canceled after 0s
Build NapCat Artifacts / Type Check & Test (push) Canceled after 0s
Build NapCat Artifacts / Build NapCat.Framework (push) Canceled after 0s
Build NapCat Artifacts / Build NapCat.Shell (push) Canceled after 0s
54 lines
2.1 KiB
Plaintext
54 lines
2.1 KiB
Plaintext
import * as react from 'react';
|
|
import * as tailwind_variants from 'tailwind-variants';
|
|
import * as _heroui_system_rsc from '@heroui/system-rsc';
|
|
import { PropGetter, HTMLHeroUIProps } from '@heroui/system-rsc';
|
|
import { KbdVariantProps, SlotsToClasses, KbdSlots } from '@heroui/theme';
|
|
import { ReactRef } from '@heroui/react-utils';
|
|
import { KbdKey } from './utils.js';
|
|
|
|
interface Props extends HTMLHeroUIProps<"kbd"> {
|
|
/**
|
|
* Ref to the DOM node.
|
|
*/
|
|
ref?: ReactRef<HTMLElement | null>;
|
|
/**
|
|
* The key or keys to be displayed.
|
|
*/
|
|
keys?: KbdKey | KbdKey[];
|
|
/**
|
|
* Classname or List of classes to change the classNames of the element.
|
|
* if `className` is passed, it will be added to the base slot.
|
|
*
|
|
* @example
|
|
* ```ts
|
|
* <Kbd classNames={{
|
|
* base:"base-classes",
|
|
* abbr: "abbr-classes", // the key wrapper
|
|
* content: "content-classes", // the children wrapper
|
|
* }} />
|
|
* ```
|
|
*/
|
|
classNames?: SlotsToClasses<KbdSlots>;
|
|
}
|
|
type UseKbdProps = Props & KbdVariantProps;
|
|
declare function useKbd(originalProps: UseKbdProps): {
|
|
Component: _heroui_system_rsc.As<any>;
|
|
slots: {
|
|
base: (slotProps?: ({} & tailwind_variants.ClassProp<ClassValue>) | undefined) => string;
|
|
abbr: (slotProps?: ({} & tailwind_variants.ClassProp<ClassValue>) | undefined) => string;
|
|
content: (slotProps?: ({} & tailwind_variants.ClassProp<ClassValue>) | undefined) => string;
|
|
} & {
|
|
base: (slotProps?: ({} & tailwind_variants.ClassProp<ClassValue>) | undefined) => string;
|
|
abbr: (slotProps?: ({} & tailwind_variants.ClassProp<ClassValue>) | undefined) => string;
|
|
content: (slotProps?: ({} & tailwind_variants.ClassProp<ClassValue>) | undefined) => string;
|
|
} & {};
|
|
classNames: SlotsToClasses<"abbr" | "base" | "content"> | undefined;
|
|
title: string | undefined;
|
|
children: react.ReactNode;
|
|
keysToRender: KbdKey[];
|
|
getKbdProps: PropGetter<Record<string, unknown>, _heroui_system_rsc.DOMAttributes<_heroui_system_rsc.DOMElement>>;
|
|
};
|
|
type UseKbdReturn = ReturnType<typeof useKbd>;
|
|
|
|
export { UseKbdProps, UseKbdReturn, useKbd };
|