# org.atsui.List

> Published by [atsui.org](https://lexicon.garden/identity/did:plc:e4fjueijznwqm2yxvt7q4mba)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:e4fjueijznwqm2yxvt7q4mba/org.atsui.List)
- [Documentation](https://lexicon.garden/lexicon/did:plc:e4fjueijznwqm2yxvt7q4mba/org.atsui.List/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:e4fjueijznwqm2yxvt7q4mba/org.atsui.List/examples)

## Definitions

### `org.atsui.List`

**Type**: `procedure`

Scrollable vertical list with paginated data source.

#### Input

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `input` | `unknown` | No | Parameters to pass to the query. |
| `query` | `string` (nsid) | Yes | XRPC query to call for pages of items. Resolved through the import stack via at.inlay.endpoint records. |

#### Output

**Encoding**: `application/json`

### `org.atsui.List#page`

**Type**: `object`

Response shape from a List data source query.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `items` | `array` | Yes | Elements to render as list rows. |
| `cursor` | `string` | No | Opaque pagination token. Absent means no more items. |

## Raw Schema

```json
{
  "id": "org.atsui.List",
  "defs": {
    "main": {
      "type": "procedure",
      "input": {
        "schema": {
          "type": "object",
          "required": [
            "query"
          ],
          "properties": {
            "input": {
              "type": "unknown",
              "description": "Parameters to pass to the query."
            },
            "query": {
              "type": "string",
              "format": "nsid",
              "description": "XRPC query to call for pages of items. Resolved through the import stack via at.inlay.endpoint records."
            }
          }
        },
        "encoding": "application/json"
      },
      "output": {
        "schema": {
          "ref": "at.inlay.defs#response",
          "type": "ref"
        },
        "encoding": "application/json"
      },
      "description": "Scrollable vertical list with paginated data source."
    },
    "page": {
      "type": "object",
      "required": [
        "items"
      ],
      "properties": {
        "items": {
          "type": "array",
          "items": {
            "ref": "at.inlay.defs#element",
            "type": "ref"
          },
          "description": "Elements to render as list rows."
        },
        "cursor": {
          "type": "string",
          "maxLength": 512,
          "description": "Opaque pagination token. Absent means no more items."
        }
      },
      "description": "Response shape from a List data source query."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```