@dnb/eufemia/extensions/forms/Field/ArraySelection/ArraySelectionDocs.js

DNB Eufemia Design System UI Library

export const ArraySelectionProperties = {
  variant: {
    doc: 'Choice of UI feature.',
    type: ['"checkbox"', '"button"', '"checkbox-button"'],
    defaultValue: '"checkbox"',
    status: 'optional'
  },
  optionsLayout: {
    doc: 'Layout for the list of options.',
    type: ['"horizontal"', '"vertical"'],
    defaultValue: '"vertical"',
    status: 'optional'
  },
  children: {
    doc: 'For providing `<Field.Option>` components. Can also be a render function that receives `{ value, options }`, where `options` are from `data` or `dataPath` and may include additional custom properties.',
    type: ['React.ReactNode', 'function'],
    status: 'optional'
  },
  size: {
    doc: 'The sizes you can choose is `small` (1.5rem), `default` (2rem), `medium` (2.5rem) and `large` (3rem) are supported component sizes. Defaults to `default` / `null`. Also, if you define a number like `size="2"` then it will be forwarded as the input element attribute. Consider rather setting field sizes with [Form.Appearance](/uilib/extensions/forms/Form/Appearance/).',
    type: 'string',
    status: 'optional'
  },
  data: {
    doc: 'Data to be used for the component. The object needs to have a `value` and a `title` property. Provide the Dropdown or Autocomplete data in the format documented here: [Dropdown](/uilib/components/dropdown) and [Autocomplete](/uilib/components/autocomplete) documentation.',
    type: 'array',
    status: 'optional'
  },
  dataPath: {
    doc: 'The path to the context data (Form.Handler). The context data object needs to have a `value` and a `title` property. The generated options will be placed above given JSX based children. When `children` is a function, the generated options are instead provided as `options` to the function.',
    type: 'string',
    status: 'optional'
  }
};
//# sourceMappingURL=ArraySelectionDocs.js.map