@spaced-out/ui-design-system
Version:
Sense UI components library
111 lines • 3.16 kB
TypeScript
import * as React from 'react';
import type { BadgedIconProps } from './';
declare const _default: {
tags: string[];
title: string;
component: ({ name, showBadge, classNames, size, type, ariaLabel, }: BadgedIconProps) => React.JSX.Element;
argTypes: {
classNames: {
description: string;
control: {
type: string;
};
table: {
type: {
summary: string;
};
};
};
showBadge: {
description: string;
control: {
type: string;
};
table: {
type: {
summary: string;
};
defaultValue: {
summary: string;
};
};
};
type: {
description: string;
options: string[];
control: {
type: string;
};
table: {
type: {
summary: string;
};
defaultValue: {
summary: string;
};
};
};
name: {
readonly description: "Icon Name represents name of icon as supported by fontawesome";
readonly type: {
readonly required: true;
};
readonly table: {
readonly type: {
readonly summary: "string";
};
readonly defaultValue: {
readonly summary: "face-party";
};
};
};
size: {
readonly description: "Icon supports three size variants namely small and medium. `small` < `medium` < `large`";
readonly options: unknown[];
readonly control: {
readonly type: "select";
};
readonly table: {
readonly type: {
readonly summary: "string";
};
readonly defaultValue: {
readonly summary: "medium";
};
};
};
ariaLabel: {
readonly control: {
readonly type: "text";
};
readonly description: "**aria-label** should be added where `ClickableIcon` and `CloseIcon` is used. This would avoid accessibility violations in screen readers";
readonly table: {
readonly type: {
readonly summary: "string";
};
};
};
};
parameters: {
docs: {
subtitle: string;
description: {
component: string;
};
};
storySource: {
componentPath: string;
};
};
};
export default _default;
export declare const _BadgedIcon: {
(args: BadgedIconProps): React.JSX.Element;
args: {
classNames: {
wrapper: string;
};
name: string;
};
};
//# sourceMappingURL=BadgedIcon.stories.d.ts.map