iblis-simple-crud

Beautiful React UI component built with Material-UI to manage (create, update and delete) a simple object list

Usage no npm install needed!

<script type="module">
  import iblisSimpleCrud from 'https://cdn.skypack.dev/iblis-simple-crud';
</script>

README

Iblis Simple Crud

Beautiful React UI component built with Material-UI to manage (create, update and delete) a simple object list

NPM version

Example

Demos

Why

When you develop a web app, you always need to have an UI to manage simple object. For example a list of admin email, a list of categories, ... Mostly what you need is to edit one text field. You don't need pagination or filer, ect ...

After some search, no React component libraries has the following requirements :

  • Written in pure Typescript
  • Use last version of Material-UI
  • Use last version of Formik
  • Agnostic of any calling server libraries
  • No state maintain by the components under the hood (if you want refresh the data, change the props of your component)
  • Fully responsive
  • Detailed documentation
  • Easy to use and yet customizable
  • Easy to change the look with Material-UI Theme

Documentation and Basic Usage

All props and documented example can be found in the storybook

Install

Install the library and the dependencies to your React project

npm install iblis-simple-crud @material-ui/core @material-ui/icons formik@next

Test

You can see many visual implemenation of the components in the storybook

You can launch test by running npm run test

Dev

To launch dev environement with storybook npm run start

Then you will be able to see your components and test it on http://localhost:9010

All the documention and test are done in the stories folder

Contribute

  1. Fork this repository to your own GitHub account and then clone it to your local device
  2. Make the necessary changes and ensure that the tests are passing
  3. Send a pull request

Todo

  • Write more tests with jest

Known issues

  • None for the moment

Thanks

License

Please, refer to LICENSE file