Git Product home page Git Product logo

modaltic's Introduction

Modaltic (Artistic tic)

ReactJs License

Always rewriting the same code for modal. Let's try an UI library. That's give more control on the UI with prebuild tools.

Usage

Add this package to your project.

pnpm install modaltic

Setup Layout:

Replace your layout page with this code.

# app/layout.tsx;
import { ModalticProvider } from "modaltic";
import "modaltic/styles.css";

export default function RootLayout({
  children,
}: {
  children: React.ReactNode;
}) {
  return (
    <html>
      <head />
      <body>
        <ModalticProvider theme="light">
          {children}
        </ModalticProvider>
      </body>
    </html>
  );
}

Show Model

"use client";
import React from "react";
import { useModaltic } from "modaltic";
import { CustomForm } from "../components";

export default function HomePage() {
  const modaltic = useModaltic();

  const handleShowDetails = () => {
    modaltic.show("customForm", CustomForm());
  };

  return (
    <div className="card">
      <h4 className="cardTitle">I can do this</h4>
      <button className="cardButton" onClick={handleShowDetails}>
        See more
      </button>
    </div>
  );
}

Custom Styling for Model

We have some css variable. That's help you to change the color and apperance of the model.

  • --modaltic: Primary color of the modal.
  • --modaltic-2nd: Secondary color of the modal.
  • --modaltic-shadow: Shadow color of the modal.
  • --modaltic-padding: Padding inside the modal.
  • --modaltic-z-index: Z-Index of the modal.

Sizes

.modaltic {
  --modalx-padding: 4rem 1rem;
  --modalx-z-index: 10;
}

Theme

Our default theme mode is dark. You can change the theme mode by adding this class .modaltic-light.

/* on dark mode */
.modaltic {
  --modaltic: hsl(219, 32%, 12%);
  --modaltic-2nd: hsl(219, 8%, 75%);
  --modaltic-shadow: rgba(0, 0, 0, 0.5);
}

/* on light mode */
.modaltic-light {
  --modaltic: hsl(219, 100%, 99%);
  --modaltic-2nd: hsl(219, 8%, 50%);
  --modaltic-shadow: rgba(0, 0, 0, 0.1);
}

Contributing

Contributions are welcome! I would like you to contribute in this project.

Roadmap

This project is in its early stages, and there are many missing features that need implementation. Check the Issues section for a list of features, enhancements, and bug fixes that are planned.

License

This project is licensed under the MIT License - see the LICENSE file for details.

modaltic's People

Watchers

Md Mahi Kaishar avatar

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.