1.0.4 • Published 1 year ago

basic-react-modal v1.0.4

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

basic-react-modal

A simple and easy to use modal

NPM JavaScript Style Guide

Install

npm install --save basic-react-modal

Usage

import React, { Component } from 'react'

import {CustomModal} from 'basic-react-modal'
import 'basic-react-modal/dist/index.css'

App = () => {
  //We use this state to show or hide the modal
  const [showModal, setShowModal] = React.useState(false)
  //We use this variable to put the content of the modal and put it in the children prop
  const contentModal = (
    <>
      <h2>It's a title</h2>
      <p>John Titor was probably right</p>
      <button onClick={() => setShowModal(!showModal)}>Okay</button>
    </>
  )
  return (
    <section>
      <h1>Basic react modal</h1>
      <button onClick={() => setShowModal(!showModal)}>Open the modal</button>
      <CustomModal show={showModal} children={contentModal} close={() => setShowModal(!showModal)} contentContainerStyle={{backgroundColor:"gray"}}  />
    </section>
  )
}

Typescript support ("any" error when importing the library)

// Step 1 --> create a new file in the root folder called "typings.d.ts" by example
// Step 2 --> add to it : declare module "basic-react-modal"
// Step 3 --> Go to tsconfig.json and add into "includes" section, the name of your file (typings.d.ts by example)
// Step 4 --> No more "any" error

License

MIT © FrSenpai

1.0.4

1 year ago

1.0.3

1 year ago

1.0.2

2 years ago

1.0.1

2 years ago

1.0.0

2 years ago