@dnb/eufemia
Version:
DNB Eufemia Design System UI Library
39 lines • 1.52 kB
JavaScript
import { UlProperties } from "../../elements/lists/UlDocs.js";
import { OlProperties } from "../../elements/lists/OlDocs.js";
const ListProperties = {
...UlProperties,
...OlProperties
};
const {
children,
...ListPropertiesWithoutChildren
} = ListProperties;
export const ListFormatProperties = {
value: {
doc: 'The value to format. Can be given as `children` instead.',
type: ['Array<React.ReactNode>'],
status: 'optional'
},
children: {
doc: 'The children to format.',
type: 'React.ReactNode',
status: 'optional'
},
format: {
doc: 'Formatting options for the value when variant is `text`. See the [Intl.ListFormat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/ListFormat/ListFormat) documentation.',
type: 'Intl.ListFormatOptions',
status: 'optional'
},
variant: {
doc: 'Defines if the value should be displayed in list format (`ol`, `ul`) or regular text format in one line. Defaults to `text`.',
type: ['"ol"', '"ul"', '"text"'],
status: 'optional'
},
listType: {
doc: 'Defines the type of list styling used for list variants. Used together with variant `ol` and `ul`. Variant `ol`: `a`, `A`, `i`, `I` and `1`. Variant `ul`: `circle`, `disc` and `square`. Defaults to `undefined`.',
type: ['"a"', '"A"', '"i"', '"I"', '"1"', '"circle"', '"disc"', '"square"', '"unstyled"', 'undefined'],
status: 'optional'
},
...ListPropertiesWithoutChildren
};
//# sourceMappingURL=ListFormatDocs.js.map