Type Table

Docs

A table for documenting types

it is an optional component which won't be loaded by default.

Usage

It accepts a type property.

import { TypeTable } from 'next-docs-ui/components/type-table'
 
<TypeTable
  type={{
    percentage: {
      description:
        'The percentage of scroll position to display the roll button',
      type: 'number',
      default: 0.2
    }
  }}
/>

Prop	Type	Default
`percentage`	`number`	`0.2`

Prop	Type	Default
`type`	`Record<string, ObjectType>`	-

Object Type

Prop	Type	Default
`description`	`string`	`"-"`
`type`	`string`	-
`typeDescription`	`string`	-
`typeDescriptionLink`	`string`	-

Last updated on

Tabs

Zoom Image

Type Table

Usage

Type Table

Object Type

On this page