0.3.5 • Published 5 years ago

uxcore-float-nav v0.3.5

Weekly downloads
14
License
MIT
Repository
github
Last release
5 years ago

uxcore-float-nav

React float nav

NPM version build status Test Coverage Dependency Status devDependency Status NPM downloads

Sauce Test Status

Development

git clone https://github.com/uxcore/uxcore-float-nav
cd uxcore-float-nav
npm install
npm run server

if you'd like to save your install time,you can use uxcore-tools globally.

npm install uxcore-tools -g
git clone https://github.com/uxcore/uxcore-float-nav
cd uxcore-float-nav
npm install
npm run dep
npm run start

Test Case

npm run test

Coverage

npm run coverage

Demo

http://uxcore.github.io/components/float-nav

Contribute

Yes please! See the CONTRIBUTING for details.

API

Props

FloatNavWrapper

With content wrapper.

NameTypeRequiredDefaultComments
prefixClsstringno'uxcore-float-nav'prefix classname for component
classNamestringno''custom classname for component
showOrderNumberbooleannotrueprepend order index to the nav item
widthnumberno260nav's width
heightnumberno370nav's height
offsetobjectno{right: 20, bottom: 20}nav's position offset
contentreact elementyesnullplace the content with anchor here
stepLengthnumberno50scroll length
hoverablebooleannofalseenable the haverable feature

FloatNav

Without content wrapper.

NameTypeRequiredDefaultComments
prefixClsstringno'uxcore-float-nav'prefix classname for component
classNamestringno''custom classname for component
showOrderNumberbooleannotrueprepend order index to the nav item
widthnumberno260nav's width
heightnumberno370nav's height
offsetobjectno{right: 20, bottom: 20}nav's position offset
stepLengthnumberno50scroll length

NavItem

NameTypeRequiredDefaultComments
titlereact element or stringyes''nav item's title
anchorstringyes''define the anchor
onClickfunctionnonooptrigger when nav item is clicked with two parameter(anchor, orderNumber)