@primer/react/lib-esm/Stack/Stack.d.ts

An implementation of GitHub's Primer Design System using React

import type React from 'react';
import { type ElementType } from 'react';
import type { ResponsiveValue } from '../hooks/useResponsiveValue';
import type { ForwardRefComponent as PolymorphicForwardRefComponent } from '../utils/polymorphic';
type GapScale = 'none' | 'condensed' | 'normal' | 'spacious';
type Gap = GapScale | ResponsiveValue<GapScale>;
type DirectionScale = 'horizontal' | 'vertical';
type Direction = DirectionScale | ResponsiveValue<DirectionScale>;
type AlignScale = 'stretch' | 'start' | 'center' | 'end' | 'baseline';
type Align = AlignScale | ResponsiveValue<AlignScale>;
type WrapScale = 'wrap' | 'nowrap';
type Wrap = WrapScale | ResponsiveValue<WrapScale>;
type JustifyScale = 'start' | 'center' | 'end' | 'space-between' | 'space-evenly';
type Justify = JustifyScale | ResponsiveValue<JustifyScale>;
type PaddingScale = 'none' | 'condensed' | 'normal' | 'spacious';
type Padding = PaddingScale | ResponsiveValue<PaddingScale>;
type StackProps<As> = React.PropsWithChildren<{
    /**
     * Customize the element type of the rendered container
     */
    as?: As;
    /**
     * Specify the gap between children elements in the stack
     */
    gap?: Gap;
    /**
     * Specify the direction for the stack container
     * @default vertical
     */
    direction?: Direction;
    /**
     * Specify the alignment between items in the cross-axis of the direction
     * @default stretch
     */
    align?: Align;
    /**
     * Specify whether items are forced onto one line or can wrap onto multiple lines
     * @default nowrap
     */
    wrap?: Wrap;
    /**
     * Specify how items will be distributed in the stacking direction
     * @default start
     */
    justify?: Justify;
    /**
     * Specify the padding of the stack container
     * @default none
     */
    padding?: Padding;
    className?: string;
}>;
declare const Stack: PolymorphicForwardRefComponent<ElementType, StackProps<ElementType>>;
type StackItemProps<As> = React.PropsWithChildren<{
    /**
     * Customize the element type of the rendered container
     */
    as?: As;
    /**
     * Allow item to keep size or expand to fill the available space
     * @default false
     */
    grow?: boolean | ResponsiveValue<boolean>;
    /**
     * Allow item to keep size or expand to fill the available space
     * @default true
     */
    shrink?: boolean | ResponsiveValue<boolean>;
    className?: string;
}>;
declare const StackItem: PolymorphicForwardRefComponent<ElementType, StackProps<ElementType>>;
export { Stack, StackItem };
export type { StackProps, StackItemProps };
//# sourceMappingURL=Stack.d.ts.map