Docs »

Data Queries »

UI Icons

This page previews features in the upcoming 10.0 release.

ui.icons

ui.icons data queries return a filterable and pageable list of icons.

Inputs

Req’d Key Notes
  filter: An optional keyword used to filter the results.
  limit: The desired number of results per page.
  page: The desired starting page (zero-based).

Response Formats

  • dictionaries (default) returns a table-based format suitable for sheets and API results.

Examples

Query:



type:ui.icons
filter:git
limit:10
format:dictionaries


Response:


{
  "data": [
    {
      "icon": "git-branch"
    },
    {
      "icon": "git-commit"
    },
    {
      "icon": "git-compare"
    },
    {
      "icon": "git-create"
    },
    {
      "icon": "git-delete"
    },
    {
      "icon": "git-merge"
    },
    {
      "icon": "git-private"
    },
    {
      "icon": "git-pull-request"
    }
  ],
  "_": {
    "type": "ui.icons",
    "format": "dictionaries",
    "paging": {
      "page": {
        "of": 1,
        "rows": {
          "of": 8,
          "count": 8,
          "limit": 10,
          "from": 1,
          "to": 8
        },
        "index": 0
      }
    }
  }
}