Nervous Parrot Muttering
Unleash awesomeness. Private packages, team management tools, and powerful integrations. Get started with npm Orgs »

uxcore-float-nav

0.3.3 • Public • Published

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.

Name Type Required Default Comments
prefixCls string no 'uxcore-float-nav' prefix classname for component
className string no '' custom classname for component
showOrderNumber boolean no true prepend order index to the nav item
width number no 260 nav's width
height number no 370 nav's height
offset object no {right: 20, bottom: 20} nav's position offset
content react element yes null place the content with anchor here
stepLength number no 50 scroll length
hoverable boolean no false enable the haverable feature

FloatNav

Without content wrapper.

Name Type Required Default Comments
prefixCls string no 'uxcore-float-nav' prefix classname for component
className string no '' custom classname for component
showOrderNumber boolean no true prepend order index to the nav item
width number no 260 nav's width
height number no 370 nav's height
offset object no {right: 20, bottom: 20} nav's position offset
stepLength number no 50 scroll length

NavItem

Name Type Required Default Comments
title react element or string yes '' nav item's title
anchor string yes '' define the anchor
onClick function no noop trigger when nav item is clicked with two parameter(anchor, orderNumber)

install

npm i uxcore-float-nav

Downloadsweekly downloads

18

version

0.3.3

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
Report a vulnerability