@nex-ui/react/dist/types/components/flex/types.d.ts

🎉 A beautiful, modern, and reliable React component library.

import { ElementType, ReactNode } from 'react';
import { ClassValue } from 'clsx';
import { CSSObject } from '@nex-ui/system';
import { OverrideProps, SxProp } from '../../types/utils.js';

interface FlexPropsOverrides {
}
type FlexOwnProps<RootComponent extends ElementType> = {
    /**
     * The component used for the root node.
     * @default 'div'
     */
    as?: RootComponent;
    /**
     * The system prop that allows defining system overrides as well as additional CSS styles.
     */
    sx?: SxProp<FlexOwnerState<RootComponent>>;
    /**
     * The content of the flex.
     */
    children?: ReactNode;
    /**
     * Additional class names to apply to the root element.
     */
    className?: ClassValue;
    /**
     * Set the alignment of elements in the direction of the main axis.
     */
    justify?: CSSObject['justifyContent'];
    /**
     * Set the alignment of elements in the direction of the cross axis.
     */
    align?: CSSObject['alignItems'];
    /**
     * Set how flex items are placed in the flex container that defines the main axis and the direction.
     * @default 'row'
     */
    direction?: CSSObject['flexDirection'];
    /**
     * Set whether the element is displayed in a single line or in multiple lines.
     */
    wrap?: CSSObject['flexWrap'];
    /**
     * Set the gap between flex items.
     */
    gap?: CSSObject['gap'];
    /**
     * If true, the flex container is displayed as an inline flex container.
     * @default false
     */
    inline?: boolean;
};
type FlexProps<RootComponent extends ElementType = 'div'> = OverrideProps<RootComponent, FlexOwnProps<RootComponent>, FlexPropsOverrides>;
type FlexOwnerState<RootComponent extends ElementType = 'div'> = FlexProps<RootComponent> & {
    inline: boolean;
    direction: CSSObject['flexDirection'];
};

export type { FlexOwnerState, FlexProps, FlexPropsOverrides };