https://github.com/hipstersmoothie/materialize-hooked

A component library built on materialize.css using react hooks
https://github.com/hipstersmoothie/materialize-hooked

components javascript material-ui materialize materialize-css react react-hooks

Last synced: 10 months ago
JSON representation

A component library built on materialize.css using react hooks

• Host: GitHub
• URL: https://github.com/hipstersmoothie/materialize-hooked
• Owner: hipstersmoothie
• Created: 2018-11-01T20:46:49.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-11-04T21:23:05.000Z (over 7 years ago)
• Last Synced: 2025-02-09T08:34:40.527Z (about 1 year ago)
• Topics: components, javascript, material-ui, materialize, materialize-css, react, react-hooks
• Language: TypeScript
• Homepage: http://hipstersmoothie.com/materialize-hooked/
• Size: 13 MB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# materialize-hooked

[![CircleCI](https://circleci.com/gh/hipstersmoothie/materialize-hooked.svg?style=svg)](https://circleci.com/gh/hipstersmoothie/materialize-hooked) [![Storybook](https://github.com/storybooks/press/blob/master/badges/storybook.svg)](http://hipstersmoothie.com/materialize-hooked/) [![codecov](https://codecov.io/gh/hipstersmoothie/materialize-hooked/branch/master/graph/badge.svg)](https://codecov.io/gh/hipstersmoothie/materialize-hooked)

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

This is a component library built on [materialize.css](https://materializecss.com/). It implements all of the components supported by `materialize.css` using the new [react hooks API](https://reactjs.org/docs/hooks-intro.html).

## Developing

To start the development server ([storybook](https://github.com/storybooks/storybook/)) run the following command.

```sh

yarn storybook

```

or to start in test mode (no docs)

```sh

yarn storybook-test

```

## Testing

To run all the test suites (unit, snapshot, and visual) run the following command.

```sh

yarn test

```

This can take a pretty long time cause it build the whole storybook to take screenshots locally. If you already have the storybook running (in test mode) you can use the following command the run the tests it.

```sh

yarn test-all

```

To test just the snapshots.

```sh

yarn test-snapshots

```

## Contributing

At this point `materialize-hooked` is only built by me! It fits my use case and has most of the props and options I need. This doesn't mean I've solved your problems though so feel free to create issues or open pull requests!