ziofe-horizontals
v0.0.0
Published
This repo contains the source code of several features identified as generic and reusable across Zio's Frontend.
Downloads
58
Readme
About
This repo contains the source code of several features identified as generic and reusable across Zio's Frontend.
Table of Contents
Prerequisites
- Nodejs 20+
- Yarn (npm or pnpm can be used, in that case yarn commands that are mentioned in this document to be substituted with their equivalents)
- Jfrog access
Usage
yarn add react react-dom react-router-dom primereact primeflex primeicons @emotion/react @emotion/styled date-fns- Optional if authentication is needed -
yarn add @apollo/client graphql jwt-decode - As a one time activity, do Setup Jfrog artifactory
yarn add @zafinone/ziofe-horizontals. Missing dependencies are informed through a warning.yarn add @zafinone/ziofe-theme- Import theme
import '@zafinone/ziofe-theme/base';Update dependencies
Do yarn upgrade-interactive --latest --scope "@zafinone" and choose to install the updates. Refer Changelog
Version matrix
| Primereact | Ziofe Theme | Ziofe Horizontals | | ----------- | ----------- | ----------------- | | ^10.5.2 | ^1.1.0 | ^1.14.0 | | 10.6.3 | 2.0.0 - 2.7.0 | 2.0.0 - 2.18.0 | | 10.6.6 | ^2.8.0 | ^2.19.0 |
Storybook
As the repository is mainly of components that are built on primereact, storybook remains useful to demonstrate/unit test the different view states/testcases of a component. More from the Storybook docs
To run storybook yarn storybook
Contributor notes
Read through on how to contribute to horizontals package DEVGUIDE
Theme
For theme related docs, refer to Ziofe Theme