Scryn - A Component Library

This is a component library and hooks library created for easy utility functionality in react.

• Checkout on npm : https://www.npmjs.com/package/scryn
• Install from npm :

npm i scryn

• To use the component, import it like this,

import { useFullscreen } from 'scryn';

How to contribute ?

• Fork this repo in your account. (Make sure to uncheck "Copy the main branch only")
• Create your feature branch from dev branch. And work on this branch only.
• After the implementation, raise PR from your feature branch to dev branch of main repo.
• Ask for the review.

How to implement ?

• Create a seperate folder for your component in lib/components. (i.e. lib/components/Button/)
• Create your component inside that folder. (i.e. Button.tsx);
• Create the Stories for your component in the same folder. (i.e. Button.stories.ts)
• Do not make changes to any file outside your component folder.

Naming Conventions

• For feature branch names, follow this convention :
  • component-name/sub-category
  • For Example : Loader/linear-loader
• For commit messages, follow this convention :
  • action: description
  • For Example : "fix: fix bugs related to linear loader"

Components Offered :

• useFullScreen hook