@mui/joy/TabList/TabListProps.d.ts

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.

import * as React from 'react';
import { OverridableStringUnion, OverrideProps } from '@mui/types';
import { ColorPaletteProp, SxProps, VariantProp, ApplyColorInversion } from '../styles/types';
import { SlotProps, CreateSlotsAndSlotProps } from '../utils/types';
export type TabListSlot = 'root';
export interface TabListSlots {
    /**
     * The component that renders the root.
     * @default 'div'
     */
    root?: React.ElementType;
}
export type TabListSlotsAndSlotProps = CreateSlotsAndSlotProps<TabListSlots, {
    root: SlotProps<'div', {}, TabListOwnerState>;
}>;
export interface TabListPropsColorOverrides {
}
export interface TabListPropsVariantOverrides {
}
export interface TabListPropsSizeOverrides {
}
export interface TabListTypeMap<P = {}, D extends React.ElementType = 'div'> {
    props: P & {
        /**
         * The color of the component. It supports those theme colors that make sense for this component.
         * @default 'neutral'
         */
        color?: OverridableStringUnion<ColorPaletteProp, TabListPropsColorOverrides>;
        /**
         * Used to render icon or text elements inside the TabList if `src` is not set.
         * This can be an element, or just a string.
         */
        children?: React.ReactNode;
        /**
         * If `true`, the TabList's underline will disappear.
         * @default false
         */
        disableUnderline?: boolean;
        /**
         * The flex value of the Tab.
         * @example tabFlex={1} will set flex: '1 1 auto' on each tab (stretch the tab to equally fill the available space).
         */
        tabFlex?: number | string;
        /**
         * The placement of the TabList's underline.
         * @default orientation === 'horizontal' ? 'bottom' : 'right'
         */
        underlinePlacement?: 'top' | 'bottom' | 'left' | 'right';
        /**
         * The size of the component.
         */
        size?: OverridableStringUnion<'sm' | 'md' | 'lg', TabListPropsSizeOverrides>;
        /**
         * If provided, the TabList will have postion `sticky`.
         */
        sticky?: 'top' | 'bottom';
        /**
         * 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, TabListPropsVariantOverrides>;
    } & TabListSlotsAndSlotProps;
    defaultComponent: D;
}
export type TabListProps<D extends React.ElementType = TabListTypeMap['defaultComponent'], P = {
    component?: React.ElementType;
}> = OverrideProps<TabListTypeMap<P, D>, D>;
export interface TabListOwnerState extends ApplyColorInversion<TabListProps> {
    /**
     * If `true`, the Tabs' direction is "rtl".
     */
    isRtl: boolean;
    /**
     * The orientation of the Tabs.
     */
    orientation: 'horizontal' | 'vertical';
}