# pub.leaflet.blocks.orderedList

> Published by [leaflet.pub](https://lexicon.garden/identity/did:plc:btxrwcaeyodrap5mnjw2fvmz)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:btxrwcaeyodrap5mnjw2fvmz/pub.leaflet.blocks.orderedList)
- [Documentation](https://lexicon.garden/lexicon/did:plc:btxrwcaeyodrap5mnjw2fvmz/pub.leaflet.blocks.orderedList/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:btxrwcaeyodrap5mnjw2fvmz/pub.leaflet.blocks.orderedList/examples)

## Definitions

### `pub.leaflet.blocks.orderedList`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `children` | `array` | Yes |  |
| `startIndex` | `integer` | No | The starting number for this ordered list. Defaults to 1 if not specified. |

### `pub.leaflet.blocks.orderedList#listItem`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `checked` | `boolean` | No | If present, this item is a checklist item. true = checked, false = unchecked. If absent, this is a normal list item. |
| `content` | `union` | Yes |  |
| `children` | `array` | No | Nested ordered list items. Mutually exclusive with unorderedListChildren; if both are present, children takes precedence. |
| `unorderedListChildren` | `ref` → `pub.leaflet.blocks.unorderedList` | No | A nested unordered list. Mutually exclusive with children; if both are present, children takes precedence. |

## Raw Schema

```json
{
  "id": "pub.leaflet.blocks.orderedList",
  "defs": {
    "main": {
      "type": "object",
      "required": [
        "children"
      ],
      "properties": {
        "children": {
          "type": "array",
          "items": {
            "ref": "#listItem",
            "type": "ref"
          }
        },
        "startIndex": {
          "type": "integer",
          "description": "The starting number for this ordered list. Defaults to 1 if not specified."
        }
      }
    },
    "listItem": {
      "type": "object",
      "required": [
        "content"
      ],
      "properties": {
        "checked": {
          "type": "boolean",
          "description": "If present, this item is a checklist item. true = checked, false = unchecked. If absent, this is a normal list item."
        },
        "content": {
          "refs": [
            "pub.leaflet.blocks.text",
            "pub.leaflet.blocks.header",
            "pub.leaflet.blocks.image"
          ],
          "type": "union"
        },
        "children": {
          "type": "array",
          "items": {
            "ref": "#listItem",
            "type": "ref"
          },
          "description": "Nested ordered list items. Mutually exclusive with unorderedListChildren; if both are present, children takes precedence."
        },
        "unorderedListChildren": {
          "ref": "pub.leaflet.blocks.unorderedList",
          "type": "ref",
          "description": "A nested unordered list. Mutually exclusive with children; if both are present, children takes precedence."
        }
      }
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```