d1a1135328
* docs: create a new UI docs project (#13233) * docs: create a new UI docs project * fix installation errors * docs: migrate UI docs content to new project (#13241) * Fix content * added examples for some components * finish adding examples * lint fix * fix build errors * delete empty files * path fixes + refactor * fix build error
131 lines
3.4 KiB
JSON
131 lines
3.4 KiB
JSON
{
|
|
"description": "This component is based on the `div` element and supports all of its props",
|
|
"methods": [],
|
|
"displayName": "Table.Pagination",
|
|
"props": {
|
|
"count": {
|
|
"required": true,
|
|
"tsType": {
|
|
"name": "number"
|
|
},
|
|
"description": "The total number of items."
|
|
},
|
|
"pageSize": {
|
|
"required": true,
|
|
"tsType": {
|
|
"name": "number"
|
|
},
|
|
"description": "The number of items per page."
|
|
},
|
|
"pageIndex": {
|
|
"required": true,
|
|
"tsType": {
|
|
"name": "number"
|
|
},
|
|
"description": "The current page index."
|
|
},
|
|
"pageCount": {
|
|
"required": true,
|
|
"tsType": {
|
|
"name": "number"
|
|
},
|
|
"description": "The total number of pages."
|
|
},
|
|
"canPreviousPage": {
|
|
"required": true,
|
|
"tsType": {
|
|
"name": "boolean"
|
|
},
|
|
"description": "Whether there's a previous page that can be navigated to."
|
|
},
|
|
"canNextPage": {
|
|
"required": true,
|
|
"tsType": {
|
|
"name": "boolean"
|
|
},
|
|
"description": "Whether there's a next page that can be navigated to."
|
|
},
|
|
"translations": {
|
|
"required": false,
|
|
"tsType": {
|
|
"name": "signature",
|
|
"type": "object",
|
|
"raw": "{\n of?: string\n results?: string\n pages?: string\n prev?: string\n next?: string\n}",
|
|
"signature": {
|
|
"properties": [
|
|
{
|
|
"key": "of",
|
|
"value": {
|
|
"name": "string",
|
|
"required": false
|
|
}
|
|
},
|
|
{
|
|
"key": "results",
|
|
"value": {
|
|
"name": "string",
|
|
"required": false
|
|
}
|
|
},
|
|
{
|
|
"key": "pages",
|
|
"value": {
|
|
"name": "string",
|
|
"required": false
|
|
}
|
|
},
|
|
{
|
|
"key": "prev",
|
|
"value": {
|
|
"name": "string",
|
|
"required": false
|
|
}
|
|
},
|
|
{
|
|
"key": "next",
|
|
"value": {
|
|
"name": "string",
|
|
"required": false
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"description": "An optional object of words to use in the pagination component.\nUse this to override the default words, or translate them into another language.",
|
|
"defaultValue": {
|
|
"value": "{\n of: \"of\",\n results: \"results\",\n pages: \"pages\",\n prev: \"Prev\",\n next: \"Next\",\n}",
|
|
"computed": false
|
|
}
|
|
},
|
|
"previousPage": {
|
|
"required": true,
|
|
"tsType": {
|
|
"name": "signature",
|
|
"type": "function",
|
|
"raw": "() => void",
|
|
"signature": {
|
|
"arguments": [],
|
|
"return": {
|
|
"name": "void"
|
|
}
|
|
}
|
|
},
|
|
"description": "A function that handles navigating to the previous page.\nThis function should handle retrieving data for the previous page."
|
|
},
|
|
"nextPage": {
|
|
"required": true,
|
|
"tsType": {
|
|
"name": "signature",
|
|
"type": "function",
|
|
"raw": "() => void",
|
|
"signature": {
|
|
"arguments": [],
|
|
"return": {
|
|
"name": "void"
|
|
}
|
|
}
|
|
},
|
|
"description": "A function that handles navigating to the next page.\nThis function should handle retrieving data for the next page."
|
|
}
|
|
}
|
|
} |