Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/next-rs/yew-accordion
🎵 A simple and flexible accordion component for the Yew framework.
https://github.com/next-rs/yew-accordion
accordion css rust tailwindcss yew
Last synced: 7 days ago
JSON representation
🎵 A simple and flexible accordion component for the Yew framework.
- Host: GitHub
- URL: https://github.com/next-rs/yew-accordion
- Owner: next-rs
- License: mit
- Created: 2024-01-28T17:43:44.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-02-03T18:23:48.000Z (11 months ago)
- Last Synced: 2024-12-18T19:03:36.588Z (10 days ago)
- Topics: accordion, css, rust, tailwindcss, yew
- Language: Rust
- Homepage: https://docs.rs/yew-accordion
- Size: 61.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🎵 Yew Accordion
[](https://crates.io/crates/yew-accordion)
[](https://docs.rs/yew-accordion)
[](https://crates.io/crates/yew-accordion)
[](https://yew-accordion.netlify.app/)
---
[](https://yew-accordion.netlify.app/)
---
## 📜 Introduction
Yew Accordion is a simple and flexible accordion component for the Yew framework. It allows you to create collapsible content sections easily.
## 🤔 Why is this Component Useful?
The Accordion component offers several benefits to enhance your web application:
1. 🌐 Customization: Tailor the appearance and behavior of the accordion to suit your application's design.
1. 🚀 Responsive Design: Ensures optimal viewing and navigation across various devices and screen sizes.
1. 💬 Easy Integration: Seamless integration into Yew projects with minimal setup and configuration.
## ⚙️ Installation
Integrating Yew Accordion into your Yew project is a straightforward process. Follow these steps:
1. Make sure you have Yew set up in your project. If not, refer to the [Yew documentation](https://yew.rs/docs/getting-started/introduction) for installation instructions.
1. Install the library using your preferred package manager:
```bash
$ cargo add yew-accordion
```
1. Start using the Accordion component to enhance your application's content organization.
## 🛠️ Usage
Incorporating Yew Accordion into your application is easy. Follow these steps:
1. Import the Accordion component into your Yew project:
```rust
use yew::prelude::*;
use yew_accordion::{Accordion, AccordionButton, AccordionItem};
#[function_component(App)]
pub fn app() -> Html {
html! {
{ "Hide -" }}}
collapsed_element={html! {{ "Show +" }}}
size="sm"
aria_controls="example-accordion"
container_class="my-custom-class bg-gray-800 p-4 rounded border border-gray-700"
expanded_element_class="my-expanded-class bg-gradient-to-r from-blue-700 to-blue-500 text-white p-2 rounded"
collapsed_element_class="my-collapsed-class bg-gradient-to-r from-green-700 to-green-500 text-white p-2 rounded"
content_container_class="my-content-class bg-gray-900 p-4 rounded border-t border-gray-700"
>
{ "Item 1" }
{ "Item 2" }
{ "Item 3" }
}
}
```
1. Customize the Accordion appearance and behavior using provided props.
1. Enjoy an enhanced content organization experience with Yew Accordion.
## 🔧 Props
| Name | Type | Default Value | Description |
| ---------------------- | --------------- | ------------------- | ------------------------------------------------- |
| `expanded_element` | `Html` | `Html::default()` | Content to be displayed when the accordion is expanded. |
| `collapsed_element` | `Html` | `Html::default()` | Content to be displayed when the accordion is collapsed. |
| `children` | `Html` | `Html::default()` | Child elements within the accordion. |
| `size` | `&'static str` | `""` | Size of the accordion. Possible values: "sm", "md", "lg". |
| `aria_controls` | `&'static str` | `""` | ARIA controls attribute for accessibility. |
| `container_class` | `&'static str` | `""` | Class for the container element. |
| `expanded_element_class` | `&'static str` | `""` | Class for the expanded element. |
| `collapsed_element_class` | `&'static str` | `""` | Class for the collapsed element. |
| `content_container_class` | `&'static str` | `""` | Class for the content container. |
## 📙 Examples
If you're curious about how to use it with different styling or additional features, you can check out the [examples folder](examples/tailwind) for more information.
## 🤝 Contribution
We welcome contributions from the community to enhance this component. Feel free to open issues, submit pull requests, or provide feedback. Let's collaborate to make content organization in Yew even more straightforward and interactive!
## 📜 License
Yew Accordion is licensed under the `MIT` License, allowing you to use, modify, and distribute it freely. Refer to the [`LICENSE`](LICENSE) file for more details.