@vonage/vivid-react/v3/VwcPagination/index.js

Vivid wrapped for easy React usage & IDE autocomplete support & typescript typings

/*
* DO NOT EDIT THIS FILE. IT IS GENERATED
*/
/*
Code in this file were generated using following JSON:
{
 "kind": "class",
 "description": "",
 "name": "Pagination",
 "members": [
  {
   "kind": "field",
   "name": "size",
   "type": {
    "text": "PaginationSize | undefined"
   },
   "description": "The size the pagination should have.",
   "privacy": "public"
  },
  {
   "kind": "field",
   "name": "shape",
   "type": {
    "text": "PaginationShape | undefined"
   },
   "description": "The shape the pagination should have.",
   "privacy": "public"
  },
  {
   "kind": "field",
   "name": "paginationButtons",
   "type": {
    "text": "Button[] | undefined"
   }
  },
  {
   "kind": "field",
   "name": "prevButton",
   "type": {
    "text": "Button | undefined"
   }
  },
  {
   "kind": "field",
   "name": "nextButton",
   "type": {
    "text": "Button | undefined"
   }
  },
  {
   "kind": "field",
   "name": "navIcons",
   "type": {
    "text": "boolean"
   },
   "default": "false"
  },
  {
   "kind": "field",
   "name": "pagesList",
   "readonly": true
  },
  {
   "kind": "field",
   "name": "total",
   "type": {
    "text": "number"
   },
   "default": "0"
  },
  {
   "kind": "field",
   "name": "selectedIndex",
   "type": {
    "text": "number | undefined"
   },
   "default": "0"
  },
  {
   "kind": "method",
   "name": "totalChanged",
   "parameters": [
    {
     "name": "_",
     "type": {
      "text": "number"
     }
    },
    {
     "name": "newValue",
     "type": {
      "text": "number"
     }
    }
   ]
  },
  {
   "kind": "method",
   "name": "selectedIndexChanged",
   "parameters": [
    {
     "name": "oldValue",
     "type": {
      "text": "number"
     }
    },
    {
     "name": "newValue",
     "type": {
      "text": "number"
     }
    }
   ]
  },
  {
   "kind": "method",
   "name": "paginationButtonsChanged",
   "parameters": [
    {
     "name": "_",
     "type": {
      "text": "Button[] | undefined"
     }
    },
    {
     "name": "newValue",
     "type": {
      "text": "Button[]"
     }
    }
   ]
  },
  {
   "kind": "field",
   "name": "#constrainedSelectedIndex",
   "privacy": "private",
   "readonly": true
  },
  {
   "kind": "method",
   "name": "#constrainSelectedIndex"
  },
  {
   "kind": "field",
   "name": "VIVID_VERSION",
   "static": true,
   "default": "__PACKAGE_VERSION__",
   "description": "The current version of the Vivid library, which is useful for debugging.\nIt can be accessed from any Vivid element via `<el>.constructor.VIVID_VERSION`.",
   "type": {
    "text": "string"
   },
   "inheritedFrom": {
    "name": "VividElement",
    "module": "src/shared/foundation/vivid-element/vivid-element.ts"
   }
  },
  {
   "kind": "field",
   "name": "componentName",
   "type": {
    "text": "string"
   },
   "static": true,
   "description": "Core component name, without prefix",
   "inheritedFrom": {
    "name": "VividElement",
    "module": "src/shared/foundation/vivid-element/vivid-element.ts"
   }
  }
 ],
 "events": [
  {
   "type": {
    "text": "CustomEvent<{selectedIndex: number, total: number, oldIndex: number}>"
   },
   "description": "Fires when the page changes.",
   "name": "pagination-change"
  }
 ],
 "attributes": [
  {
   "name": "size",
   "type": {
    "text": "PaginationSize | undefined"
   },
   "description": "The size the pagination should have.",
   "fieldName": "size"
  },
  {
   "name": "shape",
   "type": {
    "text": "PaginationShape | undefined"
   },
   "description": "The shape the pagination should have.",
   "fieldName": "shape"
  },
  {
   "name": "nav-icons",
   "type": {
    "text": "boolean"
   },
   "default": "false",
   "fieldName": "navIcons"
  },
  {
   "name": "total",
   "type": {
    "text": "number"
   },
   "default": "0",
   "fieldName": "total"
  },
  {
   "name": "selected-index",
   "type": {
    "text": "number | undefined"
   },
   "default": "0",
   "fieldName": "selectedIndex"
  }
 ],
 "mixins": [
  {
   "name": "Localized",
   "module": "/src/shared/patterns"
  }
 ],
 "superclass": {
  "name": "VividElement",
  "module": "/src/shared/foundation/vivid-element/vivid-element"
 },
 "vividComponent": {
  "public": true,
  "name": "pagination"
 }
}
*/
import wrapper from '@vonage/vivid-react-wrapper'
import { registerPagination } from '@vonage/vivid'

registerPagination('vvd3')

const VwcPagination = wrapper(`vvd3-pagination`,  {
    events: [{"name":"pagination-change","propName":"onPaginationChange"}],
    attributes: [],
    properties: ['size', 'shape', 'paginationButtons', 'prevButton', 'nextButton', 'navIcons', 'total', 'selectedIndex', 'VIVID_VERSION', 'componentName']
})

VwcPagination.displayName = 'VwcPagination'

export default VwcPagination