hrnet-plugin-modal
v1.0.10
Published
A plugin modal for HRnet project that displays a modal window for user interactions.
Readme
hrnet-plugin-modal
React plugin to easily display a Modal with text
Install Plugin
You can install this plugin via npm
npm install hrnet-plugin-modalPrerequisite
- React 17.x ou highter
- Node.js ≥ 18.x
- npm ≥ 7.x
Modal Component
Properties
| Prop | Type | Description |
|---------------|----------|--------------------------------------------|
| text | String | Display the title into the modal |
| onClose | Function | Callback executed when the modal is closed |
| isOpen | Boolean | Control display of the modal |
Use Modal
import { Modal } from "hrnet-plugin-modal";
function App() {
const [isOpen, setIsOpen] = useState(false);
return (
<div>
<Modal isOpen={isOpen} text={'This is a text dialog'} closeModal={() => setIsOpen(false)}/>
</div>
);
}
export default App;Version
To run this project, we recommend using Node.js version 18.x.x or higher.
You can check your current Node.js version by running:
node -vContribute
- Fork repository
npm installnpm run dev- Create a branch
feature/nom-fonctionnalité npm testto run the test- Open a Pull Request
License
This component is distributed under MIT license.
