69 lines
2.1 KiB
TypeScript
69 lines
2.1 KiB
TypeScript
import * as React from 'react';
|
|
import { ResponsiveStyleValue, SxProps, SystemProps } from '@mui/system';
|
|
import { OverrideProps, OverridableComponent } from '../OverridableComponent';
|
|
import { Theme } from '../styles/createTheme';
|
|
|
|
export interface StackOwnProps extends SystemProps<Theme> {
|
|
/**
|
|
* The content of the component.
|
|
*/
|
|
children?: React.ReactNode;
|
|
/**
|
|
* Defines the `flex-direction` style property.
|
|
* It is applied for all screen sizes.
|
|
* @default 'column'
|
|
*/
|
|
direction?: ResponsiveStyleValue<'row' | 'row-reverse' | 'column' | 'column-reverse'>;
|
|
/**
|
|
* Defines the space between immediate children.
|
|
* @default 0
|
|
*/
|
|
spacing?: ResponsiveStyleValue<number | string>;
|
|
/**
|
|
* Add an element between each child.
|
|
*/
|
|
divider?: React.ReactNode;
|
|
/**
|
|
* If `true`, the CSS flexbox `gap` is used instead of applying `margin` to children.
|
|
*
|
|
* While CSS `gap` removes the [known limitations](https://mui.com/joy-ui/react-stack/#limitations),
|
|
* it is not fully supported in some browsers. We recommend checking https://caniuse.com/?search=flex%20gap before using this flag.
|
|
*
|
|
* To enable this flag globally, follow the [theme's default props](https://mui.com/material-ui/customization/theme-components/#default-props) configuration.
|
|
* @default false
|
|
*/
|
|
useFlexGap?: boolean;
|
|
/**
|
|
* The system prop, which allows defining system overrides as well as additional CSS styles.
|
|
*/
|
|
sx?: SxProps<Theme>;
|
|
}
|
|
|
|
export interface StackTypeMap<
|
|
AdditionalProps = {},
|
|
RootComponent extends React.ElementType = 'div',
|
|
> {
|
|
props: AdditionalProps & StackOwnProps;
|
|
defaultComponent: RootComponent;
|
|
}
|
|
/**
|
|
*
|
|
* Demos:
|
|
*
|
|
* - [Stack](https://mui.com/material-ui/react-stack/)
|
|
*
|
|
* API:
|
|
*
|
|
* - [Stack API](https://mui.com/material-ui/api/stack/)
|
|
*/
|
|
declare const Stack: OverridableComponent<StackTypeMap>;
|
|
|
|
export type StackProps<
|
|
RootComponent extends React.ElementType = StackTypeMap['defaultComponent'],
|
|
AdditionalProps = {},
|
|
> = OverrideProps<StackTypeMap<AdditionalProps, RootComponent>, RootComponent> & {
|
|
component?: React.ElementType;
|
|
};
|
|
|
|
export default Stack;
|