Coder Social home page Coder Social logo

modal's Introduction

Use bigfan modal and put all your modals in one place and prevent polluting the DOM with excessive nodes.

Installation

using npm: npm i @bigfan/modal

using yarn: yarn add @bigfan/modal

The Setup

Providing the modal context

In your application entry point, wrap your app with the <Provider> component and pass it your modal types.

index.js (entry point):

import React from "react";
import { Provider } from "@bigfan/modal";
import App from "./App";

const types = {
  LOGIN: "LOGIN",
  SIGNUP: "SIGNUP",
  WARNING: "WARNING",
};

export default () => {
  return (
    <Provider types={types}>
      <App />
    </Provider>
  );
};

Define and display your modals

Inject the <Scene> component somewhere in your code where you want to display your modals and then map your modal types to the actual modals. The best place to put this component is your application layout component as shown in the following example.

Layout.js:

import React from "react";
import { Scene, useModal } from "@bigfan/modal";

import Login from "common/app/Login";
import Signup from "common/app/Signup";
import Warning from "common/app/Warning";

export default function Layout({ children }) {
  const {
    types: { LOGIN, SIGNUP, WARNING },
  } = useModal();

  const modals = {
    [LOGIN]: Login,
    [SIGNUP]: Signup,
    [WARNING]: Warning,
  };

  return (
    <styles.Wrapper>
      <GlobalStyles />
      <Nav />
      <div className="content">{children}</div>
      <Footer />
      <Scene modals={modals} />
    </styles.Wrapper>
  );
}

Create your modal

You have to wrap each of your modals with a <Modal> component.

common/app/Login.js:

import { Modal } from "@bigfan/modal";

export default function Login() {
  return (
    <Modal>
      <div>My login modal</div>
    </Modal>
  );
}

Open modals

At any component down the tree you can open any modal. In the following example, we want to open the Login modal from Navbar component:

NavBar.js:

import React from "react";
import { useModal } from "@bigfan/modal";

export default function NavBar() {
  const {
    openModal,
    modals: { LOGIN },
  } = useModal();

  return <div onClick={() => openModal(LOGIN)} />;
}

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.