@amsterdam/design-system-react
Version:
All React components from the Amsterdam Design System. Use it to compose pages in your website or application.
28 lines (27 loc) • 1.12 kB
TypeScript
/**
* @license EUPL-1.2+
* Copyright Gemeente Amsterdam
*/
import { HTMLAttributes, PropsWithChildren } from 'react';
export declare const spotlightTags: readonly ["article", "aside", "div", "footer", "section"];
type SpotlightTag = (typeof spotlightTags)[number];
export declare const spotlightColors: readonly ["azure", "green", "lime", "magenta", "orange", "yellow"];
type SpotlightColor = (typeof spotlightColors)[number];
export type SpotlightProps = PropsWithChildren<HTMLAttributes<HTMLElement>> & {
/** The HTML element to use. */
as?: SpotlightTag;
/** The background colour. */
color?: SpotlightColor;
};
/**
* @see {@link https://designsystem.amsterdam/?path=/docs/components-containers-spotlight--docs Spotlight docs at Amsterdam Design System}
*/
export declare const Spotlight: import("react").ForwardRefExoticComponent<HTMLAttributes<HTMLElement> & {
children?: import("react").ReactNode | undefined;
} & {
/** The HTML element to use. */
as?: SpotlightTag;
/** The background colour. */
color?: SpotlightColor;
} & import("react").RefAttributes<unknown>>;
export {};