@mui/joy
Version:
Joy UI is an open-source React component library that implements MUI's own design principles. It's comprehensive and can be used in production out of the box.
53 lines (52 loc) • 1.99 kB
TypeScript
import { OverridableStringUnion, OverrideProps } from '@mui/types';
import * as React from 'react';
import { ColorPaletteProp, SxProps, VariantProp, ApplyColorInversion } from '../styles/types';
import { SlotProps, CreateSlotsAndSlotProps } from '../utils/types';
export type SheetSlot = 'root';
export interface SheetSlots {
/**
* The component that renders the root.
* @default 'div'
*/
root?: React.ElementType;
}
export type SheetSlotsAndSlotProps = CreateSlotsAndSlotProps<SheetSlots, {
root: SlotProps<'div', {}, SheetOwnerState>;
}>;
export interface SheetPropsColorOverrides {
}
export interface SheetPropsVariantOverrides {
}
export interface SheetTypeMap<P = {}, D extends React.ElementType = 'div'> {
props: P & {
/**
* The content of the component.
*/
children?: React.ReactNode;
/**
* The color of the component. It supports those theme colors that make sense for this component.
* @default 'neutral'
*/
color?: OverridableStringUnion<ColorPaletteProp, SheetPropsColorOverrides>;
/**
* If `true`, the children with an implicit color prop invert their colors to match the component's variant and color.
* @default false
*/
invertedColors?: boolean;
/**
* The system prop that allows defining system overrides as well as additional CSS styles.
*/
sx?: SxProps;
/**
* The [global variant](https://mui.com/joy-ui/main-features/global-variants/) to use.
* @default 'plain'
*/
variant?: OverridableStringUnion<VariantProp, SheetPropsVariantOverrides>;
} & SheetSlotsAndSlotProps;
defaultComponent: D;
}
export type SheetProps<D extends React.ElementType = SheetTypeMap['defaultComponent'], P = {
component?: React.ElementType;
}> = OverrideProps<SheetTypeMap<P, D>, D>;
export interface SheetOwnerState extends ApplyColorInversion<SheetProps> {
}