@amsterdam/design-system-react
Version:
All React components from the Amsterdam Design System. Use it to compose pages in your website or application.
61 lines (60 loc) • 1.8 kB
TypeScript
/**
* @license EUPL-1.2+
* Copyright Gemeente Amsterdam
*/
import type { HTMLAttributes, PropsWithChildren } from 'react';
import type { CrossAlignForColumn, MainAlign } from '../common/types';
export declare const columnTags: readonly ["article", "div", "section"];
type ColumnTag = (typeof columnTags)[number];
export declare const columnGapSizes: readonly ["none", "x-small", "small", "large", "x-large"];
type ColumnGap = (typeof columnGapSizes)[number];
export type ColumnProps = PropsWithChildren<HTMLAttributes<HTMLElement>> & {
/**
* The vertical alignment of the items in the column.
* @default start
*/
align?: MainAlign;
/**
* The horizontal alignment of the items in the column.
* @default stretch
*/
alignHorizontal?: CrossAlignForColumn;
/**
* The HTML element to use.
* @default div
*/
as?: ColumnTag;
/**
* The amount of space between items.
* @default medium
*/
gap?: ColumnGap;
};
/**
* @see {@link https://designsystem.amsterdam/?path=/docs/components-layout-column--docs Column docs at Amsterdam Design System}
*/
export declare const Column: import("react").ForwardRefExoticComponent<HTMLAttributes<HTMLElement> & {
children?: import("react").ReactNode | undefined;
} & {
/**
* The vertical alignment of the items in the column.
* @default start
*/
align?: MainAlign;
/**
* The horizontal alignment of the items in the column.
* @default stretch
*/
alignHorizontal?: CrossAlignForColumn;
/**
* The HTML element to use.
* @default div
*/
as?: ColumnTag;
/**
* The amount of space between items.
* @default medium
*/
gap?: ColumnGap;
} & import("react").RefAttributes<unknown>>;
export {};