{
  "id": "uilib/components/list-format",
  "name": "ListFormat",
  "description": "A ready to use DNB list formatter.",
  "group": "components",
  "slug": "/uilib/components/list-format/",
  "props": [
    {
      "name": "value",
      "doc": "The value to format. Can be given as `children` instead.",
      "type": [
        "Array<React.ReactNode>"
      ],
      "status": "optional",
      "defaultValue": null
    },
    {
      "name": "children",
      "doc": "The children to format.",
      "type": "React.ReactNode",
      "status": "optional",
      "defaultValue": null
    },
    {
      "name": "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",
      "defaultValue": null
    },
    {
      "name": "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",
      "defaultValue": null
    },
    {
      "name": "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",
      "defaultValue": null
    },
    {
      "name": "inside",
      "doc": "Defines the position of the marker.",
      "type": "boolean",
      "status": "optional",
      "defaultValue": null
    },
    {
      "name": "outside",
      "doc": "Defines the position of the marker (default).",
      "type": "boolean",
      "status": "optional",
      "defaultValue": null
    },
    {
      "name": "nested",
      "doc": "Will ensure a nested structure of several lists.",
      "type": "boolean",
      "status": "optional",
      "defaultValue": null
    },
    {
      "name": "innerRef",
      "doc": "Send along a custom React Ref.",
      "type": "React.RefObject",
      "status": "optional",
      "defaultValue": null
    }
  ],
  "events": [],
  "related": [
    "Space"
  ],
  "checksum": "f41dfce91b360439c159054424e8c746da943de487366e3f9f41abf83e0c59eb",
  "source": {
    "repo": "https://github.com/dnbexperience/eufemia",
    "file": "packages/dnb-eufemia/src/components/list-format/ListFormat.tsx",
    "permalink": "https://github.com/dnbexperience/eufemia/blob/main/packages/dnb-eufemia/src/components/list-format/ListFormat.tsx"
  },
  "sources": {
    "entry": {
      "local": "src/docs/uilib/components/list-format.mdx",
      "public": "https://7054fffd.eufemia-e25.pages.dev/uilib/components/list-format/"
    },
    "props": {
      "local": "src/docs/uilib/components/list-format/properties.mdx",
      "public": "https://7054fffd.eufemia-e25.pages.dev/uilib/components/list-format/properties/"
    },
    "events": null,
    "demos": {
      "local": "src/docs/uilib/components/list-format/demos.mdx",
      "public": "https://7054fffd.eufemia-e25.pages.dev/uilib/components/list-format/demos/"
    }
  },
  "version": "0.0.0-development",
  "generatedAt": "2025-12-18T10:03:59.988Z",
  "schemaVersion": 1
}