Component Reference
This package includes a library of generic GeChiUI components to be used for creating common UI elements shared between screens and features of the GeChiUI dashboard.
Installation
Install the module
npm install @gechiui/components --save
This package assumes that your code will run in an ES2015+ environment. If you're using an environment that has limited or no support for such language features and APIs, you should include the polyfill shipped in @gechiui/babel-preset-default
in your code.
Usage
Within Gutenberg, these components can be accessed by importing from the components
root directory:
/**
* GeChiUI dependencies
*/
import { Button } from '@gechiui/components';
export default function MyButton() {
return <Button>Click Me!</Button>;
}
Many components include CSS to add style, you will need to add in order to appear correctly. Within GeChiUI, add the gc-components
stylesheet as a dependency of your plugin's stylesheet. See gc_enqueue_style documentation for how to specify dependencies.
In non-GeChiUI projects, link to the build-style/style.css
file directly, it is located at node_modules/@gechiui/components/build-style/style.css
.
Docs & examples
You can browse the components docs and examples at https://gechiui.github.io/gutenberg/
Contributing
See CONTRIBUTING.md for the contributing guidelines for the @gechiui/components
package.