UNPKG

@hakit/components

Version:
27 lines 1.56 kB
import { EntityName } from '@hakit/core'; import { TooltipProps, CardBaseProps } from '../..'; import { IconProps } from '@iconify/react'; type OmitProperties = "title" | "active"; export interface FabCardProps<E extends EntityName> extends Omit<CardBaseProps<"button", E>, OmitProperties> { /** The size of the Fab, this applies to the width and height @default 48 */ size?: number; /** Optional icon param, this is automatically retrieved by the "domain" name if provided, or can be overwritten with a custom value */ icon?: string | null; /** the props for the icon, which includes styles for the icon */ iconProps?: Omit<IconProps, "icon">; /** will not show any icons */ noIcon?: boolean; /** the title used for the tooltip and or modal that will expands, defaults to entity name or domain name */ title?: string; /** the tooltip placement @default "top" */ tooltipPlacement?: TooltipProps["placement"]; /** active flag for the state of the fab, by default this is active if the entity.state value is ON, if you want to control this just pass the prop */ active?: boolean; } /** The Fab (Floating Action Button) Card is a simple button with an icon to trigger something on press * * NOTE: This component does NOT have any media queries by default, it will just be the width set by the size prop or the default size. */ export declare function FabCard<E extends EntityName>(props: FabCardProps<E>): import("@emotion/react/jsx-runtime").JSX.Element; export {}; //# sourceMappingURL=index.d.ts.map