@dnb/eufemia/components/progress-indicator/ProgressIndicatorDocs.js

DNB Eufemia Design System UI Library

export const ProgressIndicatorProperties = {
  progress: {
    doc: 'A number between 0-100, if not supplied a continuous loading-type animation will be used.',
    type: ['string', 'number'],
    defaultValue: 'undefined',
    status: 'optional'
  },
  show: {
    doc: 'Defines the visibility of the progress. Toggling the `show` property to `false` will force a fade-out animation.',
    type: 'boolean',
    defaultValue: 'true',
    status: 'optional'
  },
  type: {
    doc: 'Defines the type.',
    type: ['"circular"', '"linear"', '"countdown"'],
    defaultValue: '"circular"',
    status: 'optional'
  },
  noAnimation: {
    doc: 'Disables the fade-in and fade-out animation.',
    type: 'boolean',
    defaultValue: 'false',
    status: 'optional'
  },
  size: {
    doc: 'Defines the size.',
    type: ['"default"', '"small"', '"medium"', '"large"', '"huge"', 'string'],
    defaultValue: '"default"',
    status: 'optional'
  },
  label: {
    doc: 'Content of a custom label. (Overrides `indicatorLabel` and `showDefaultLabel`.)',
    type: 'React.ReactNode',
    defaultValue: 'undefined',
    status: 'optional'
  },
  children: {
    doc: 'Same as `label` prop (`label` prop has priority).',
    type: 'React.ReactNode',
    defaultValue: 'undefined',
    status: 'optional'
  },
  labelDirection: {
    doc: "Sets the position of the label. `'inside'` only works with `type='circular'.",
    type: ['"horizontal"', '"vertical"', '"inside"'],
    defaultValue: '"vertical"',
    status: 'optional'
  },
  showDefaultLabel: {
    doc: 'If set to `true` a default label (from text locales) will be shown.',
    type: 'boolean',
    defaultValue: 'false',
    status: 'optional'
  },
  indicatorLabel: {
    doc: 'Use this to override the default label from text locales.',
    type: 'string',
    defaultValue: 'undefined',
    status: 'optional'
  },
  title: {
    doc: 'Used to set title and `aria-label`. Defaults to the value of progress property, formatted as a percent.',
    type: 'string',
    defaultValue: 'undefined',
    status: 'optional'
  },
  '[customColors](/uilib/components/progress-indicator/properties/#data-object-customcolors)': {
    doc: 'Send in custom css colors that overrides any css. See below for data structure.',
    type: 'object',
    defaultValue: 'undefined',
    status: 'optional'
  },
  customCircleWidth: {
    doc: 'Send in custom css width for circle progress line. (`undefined` defaults to one eighth of the size).',
    type: 'string',
    defaultValue: 'undefined',
    status: 'optional'
  },
  '[Space](/uilib/layout/space/properties)': {
    doc: 'Spacing properties like `top` or `bottom` are supported.',
    type: ['string', 'object'],
    status: 'optional'
  }
};
export const CustomColorsData = {
  line: {
    doc: 'Override the moving line color.',
    type: 'string',
    defaultValue: 'undefined',
    status: 'optional'
  },
  shaft: {
    doc: 'Override the background line color.',
    type: 'string',
    defaultValue: 'undefined',
    status: 'optional'
  },
  background: {
    doc: 'Set a background color for the center of the circle.',
    type: 'string',
    defaultValue: 'undefined',
    status: 'optional'
  }
};
export const ProgressIndicatorEvents = {
  onComplete: {
    doc: "Will be called once it's no longer visible (`show=false`).",
    type: 'function',
    defaultValue: 'undefined',
    status: 'optional'
  }
};
//# sourceMappingURL=ProgressIndicatorDocs.js.map