@mui/internal-docs-infra
Version:
MUI Infra - internal documentation creation tools.
26 lines • 1.2 kB
text/typescript
/**
* Configuration for the ordering of props, data attributes, CSS variables,
* component exports, namespace parts, and type suffixes in generated documentation.
*
* Each array defines the order in which items should appear. Items not in the array
* are placed at the position of the `__EVERYTHING_ELSE__` marker, sorted alphabetically.
*/
export type OrderingConfig = {
/** Order of CSS custom properties in documentation output */
cssVariables?: string[];
/** Order of data-* attributes in documentation output */
dataAttributes?: string[];
/** Order of component props in documentation output */
props?: string[];
/** Order of namespace member parts (e.g., Root, Trigger, Item) */
namespaceParts?: string[];
/** Order of type suffixes (e.g., Props, State, DataAttributes) */
typeSuffixes?: string[];
};
export declare const cssVariables: string[];
export declare const dataAttributes: string[];
export declare const props: string[];
export declare const namespaceParts: string[];
export declare const typeSuffixes: string[];
/** Default ordering configuration using the arrays defined in this file. */
export declare const defaultOrdering: Required<OrderingConfig>;