https://github.com/bolasblack/react-components

Some useful react components.
https://github.com/bolasblack/react-components

Last synced: 3 months ago
JSON representation

Some useful react components.

• Host: GitHub
• URL: https://github.com/bolasblack/react-components
• Owner: bolasblack
• Created: 2018-12-13T14:37:59.000Z (about 6 years ago)
• Default Branch: develop
• Last Pushed: 2024-10-21T13:21:15.000Z (3 months ago)
• Last Synced: 2024-10-27T23:16:46.534Z (3 months ago)
• Language: TypeScript
• Homepage: https://react-components.c4605.com/
• Size: 9.3 MB
• Stars: 2
• Watchers: 3
• Forks: 1
• Open Issues: 14
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# @c4605/react-components [![Build Status](https://travis-ci.com/bolasblack/react-components.svg?branch=master)](https://travis-ci.com/bolasblack/react-components) [![Coverage Status](https://coveralls.io/repos/github/bolasblack/react-components/badge.svg?branch=master)](https://coveralls.io/github/bolasblack/react-components?branch=master) [![Netlify Status](https://api.netlify.com/api/v1/badges/959b0ca3-36af-424d-b710-0f596303ff03/deploy-status)](https://react-components.c4605.com/)

Some useful react components.

- [DocumentElement](https://react-components.c4605.com/document-element-readme) ([README.mdx](./packages/DocumentElement/README.mdx)): Provides a declarative way to specify `document.documentElement` attributes in a single-page app.

- [Portal](https://react-components.c4605.com/portal-readme) ([README.mdx](./packages/Portal/README.mdx)): Strong enough [`React.createPortal`](https://reactjs.org/docs/react-dom.html#createportal) replacement. Make most `React.createPortal` use case easier.

- [Popover](https://react-components.c4605.com/popover-readme) ([README.mdx](./packages/Popover/README.mdx)): Powerful and highly customizable popover component, can adapt to most use case.

- [Modal](https://react-components.c4605.com/modal-readme) ([README.mdx](./packages/Modal/README.mdx)): A simple modal component. Provide react hook `useModal`.

## Documention

* https://react-components.c4605.com/

* or read `README.mdx` in `packages/`;

* or execute `pnpm install && pnpm storybook` to run a [storybook](https://storybook.js.org/) server.

## Unit test

### Run unit test

```

pnpm test

```

### Run unit test in watch mode

1. Install [watchman](https://facebook.github.io/watchman/)

1. `pnpm test --watch`

## Release

1. `cp .envrc.example .envrc`

1. Edit `.envrc`

1. Install [direnv](https://direnv.net/)

1. `direnv allow`