0.1.0 • Published 3 years ago

@talixo/navigation v0.1.0

Weekly downloads
8
License
MIT
Repository
github
Last release
3 years ago

Talixo Navigation

UI Component which represents Navigation

How to install

Package is available as @talixo/navigation in NPM registry, so you can use it in your project using npm install @talixo/navigation --save or yarn add @talixo/navigation.

Requirements

Your package should additionally have some extra dependencies:

  • @talixo/shared: ^0.1.0
  • @talixo/tooltip: ^0.1.0
  • lodash: ^4.17.10
  • prop-types: ^15.6.1
  • react: ^16.2.0
  • react-dom: ^16.2.0

These packages are required by @talixo/navigation, but you have to install them manually, to avoid having different versions of these in your application.

Supported props

Navigation

It allows any props which are allowed for ul. Additionally, it handles some differently:

Property nameTypeDefaultDescription
childrennoden/aNavigation items
classNamestringn/aAdditional class name passed to wrapper
dividernoden/aDivider
typeNavigationType'navigation'Type of navigation

Element

It allows any props which are allowed for li. Additionally, it handles some differently:

Property nameTypeDefaultDescription
activeboolfalseActive state
childrennoden/aElement items
classNamestringn/aAdditional class name passed to element
completedboolfalseCompleted state
disabledboolfalseDisabled state
onClickfuncn/aFunction passed to element

Step

It allows any props which are allowed for li. Additionally, it handles some differently:

Property nameTypeDefaultDescription
activeboolfalseActive state
childrennoden/aTooltips content
classNamestringn/aAdditional class name passed to element
completedboolfalseCompleted state
disabledboolfalseDisabled state
onClickfuncn/aFunction passed to element

ControlledPagination

Property nameTypeRequiredDefaultDescription
activePagenumber1Active page
displayedLimitnumber10Maximum number of displayed page buttons
nextLabelnode'Next'Next button label
onChangefuncn/aFunction passed to page buttons
pageCountnumberyesn/aThe total number of pages
previousLabelnode'Previous'Previous button label

ControlledTabs

Property nameTypeRequiredDefaultDescription
activeTabnumber0Active tab
labelsLabel[][]List of tab labels
onChangefuncn/aFunction passed to page buttons

Steps

Property nameTypeRequiredDefaultDescription
currentobjectn/aActive step
stepsStep[][]List of steps
onChangefuncn/aFunction passed to step buttons

Types

Type nameEnum options
NavigationType'navigation', 'pagination', 'breadcrumbs', 'tabs'

Property shapes

Label

Property nameTypeRequiredDefaultDescription
idnumberyesn/aLabel's id
namestringyesn/aLabel's name

Step

Property nameTypeRequiredDefaultDescription
namestringyesn/aStep's name
disabledbooleanyesn/aDisabled state

Changelog

  • 0.1.0 - initial version
1.0.0-alpha.35

3 years ago

1.0.0-alpha.31

3 years ago

1.0.0-alpha.30

3 years ago

1.0.0-alpha.27

3 years ago

1.0.0-alpha.24

3 years ago

1.0.0-alpha.20

4 years ago

1.0.0-alpha.19

4 years ago

1.0.0-alpha.16

4 years ago

1.0.0-alpha.12

4 years ago

1.0.0-alpha.7

4 years ago

1.0.0-alpha.6

4 years ago

1.0.0-alpha.5

4 years ago

1.0.0-alpha.4

4 years ago

1.0.0-alpha.2

4 years ago

0.1.0

4 years ago