https://github.com/nostr-components/modal

modal
https://github.com/nostr-components/modal

components nostr

Last synced: 8 months ago
JSON representation

modal

• Host: GitHub
• URL: https://github.com/nostr-components/modal
• Owner: nostr-components
• License: mit
• Created: 2023-05-21T08:15:28.000Z (over 2 years ago)
• Default Branch: gh-pages
• Last Pushed: 2023-05-21T09:45:49.000Z (over 2 years ago)
• Last Synced: 2025-01-15T04:25:04.442Z (10 months ago)
• Topics: components, nostr
• Language: JavaScript
• Homepage: https://nostr-components.github.io/modal/
• Size: 28.3 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


  

  
modal



  

modal



---



Documentation



---

[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/nostr-components/modal/blob/gh-pages/LICENSE)

[![npm](https://img.shields.io/npm/v/nostr-components-modal)](https://npmjs.com/package/nostr-components-modal)

[![npm](https://img.shields.io/npm/dw/nostr-components-modal.svg)](https://npmjs.com/package/nostr-components-modal)

[![Github Stars](https://img.shields.io/github/stars/nostr-components/modal.svg)](https://github.com/nostr-components/modal/)

Certainly, here's an example of a beautiful `README.md` for your Modal component:

---

# Nostr Modal Component

Welcome to the repository for the Nostr Modal Component! This is a lightweight, versatile modal component that can be used in any application built using Preact. Whether you're displaying information, warnings, or forms, the Nostr Modal Component is designed to make it easy to create user-friendly modal dialogs.

## Features

- 🎨 Customizable: You can easily customize the content and appearance of the modal.

- 🧱 Built with Preact: This component is built with Preact, a fast, 3KB alternative to React with the same modern API.

- 🔄 Dynamic: The modal can be opened and closed programmatically, making it easy to integrate into your application.

- 💻 Versatile: This component can be used for a variety of purposes, from displaying information to gathering user input.

## Installation

To use this component in your project, you can download the source code from this repository. 

## Usage

Here's a simple example of how to use the Nostr Modal Component:

```html

  

  

    

    

    

    

      const { h, render } = preact;

      const html = htm.bind(h);

      render(html`<${Modal} content="This is my custom content!" />`, document.body);

    

  

```

Replace `"This is my custom content!"` with the content you want to display in the modal.

## Contributing

We welcome contributions to the Nostr Modal Component! Please feel free to open issues or submit pull requests.

## License

- MIT