Inline documentation (#79)

* document accordion component

* document alert dialog

* document aspect ratio

* document avatar

* document calendar component

* document checkbox component

* document collapsible

* document context menu

* document dialog component

* document dropdown menu

* document hover card

* document label

* Document menubar

* document navbar

* document popover

* document progress component

* document radio group

* document scroll area

* document separator

* document switch component

* document tabs

* document toggle

* document select component

* document toggle group

* document more menu props

* revert complains changes

* document tooltip

* document toolbar

* document toast provider component

* fix tests

* remove broken support for range sliders

* document slider component

* add a short readme

* fix clippy

* Fix a few props with missing docs

* fix docs test

* switch the title of the styled components to from dioxus primitives to dioxus components

Author: ealmloff

preview/src/components/hover_card/docs.md

@@ -13,9 +13,9 @@ HoverCard {
     // The HoverCardContent contains the content that will be displayed when the user hovers over the trigger.
     HoverCardContent {
         // The side of the HoverCardTrigger where the content will be displayed. Can be one Top, Right, Bottom, or Left.
-        side: HoverCardSide::Bottom,
+        side: ContentSide::Bottom,
         // The alignment of the HoverCardContent relative to the HoverCardTrigger. Can be one of Start, Center, or End.
-        align: HoverCardAlign::Start,
+        align: ContentAlign::Start,
         // The content of the hover card, which can include text, images, or any other elements.
         {children}
     }

preview/src/components/hover_card/mod.rs

@@ -1,7 +1,9 @@
 use dioxus::prelude::*;
-use dioxus_primitives::hover_card::{
-    HoverCard, HoverCardContent, HoverCardSide, HoverCardTrigger,
+use dioxus_primitives::{
+    hover_card::{HoverCard, HoverCardContent, HoverCardTrigger},
+    ContentSide,
 };
+
 #[component]
 pub(super) fn Demo() -> Element {
     rsx! {
@@ -15,7 +17,7 @@ pub(super) fn Demo() -> Element {
                 HoverCardTrigger { class: "hover-card-trigger",
                     i { "Dioxus" }
                 }
-                HoverCardContent { class: "hover-card-content", side: HoverCardSide::Bottom,
+                HoverCardContent { class: "hover-card-content", side: ContentSide::Bottom,
                     div {
                         padding: "1rem",
                         "Dioxus is"

preview/src/components/toast/docs.md

@@ -13,10 +13,10 @@ ToastProvider {
             toast_api
                 .error(
                     "Critical Error".to_string(),
-                    Some(ToastOptions {
-                        permanent: true,
-                        ..Default::default()
-                    }),
+                    ToastOptions::new()
+                        .description("Some info you need")
+                        .duration(Duration::from_secs(60))
+                        .permanent(false),
                 );
         },
         "Show Toast"

preview/src/components/toast/mod.rs

@@ -30,13 +30,10 @@ fn ToastButton() -> Element {
                 toast_api
                     .info(
                         "Custom Toast".to_string(),
-                        Some(ToastOptions {
-                            description: Some(
-                                "Some info you need".to_string(),
-                            ),
-                            duration: Some(Duration::from_secs(60)),
-                            permanent: false,
-                        }),
+                        ToastOptions::new()
+                            .description("Some info you need")
+                            .duration(Duration::from_secs(60))
+                            .permanent(false),
                     );
             },
             "Info (60s)"

preview/src/main.rs

@@ -527,7 +527,7 @@ fn Home(iframe: Option<bool>, dark_mode: Option<bool>) -> Element {
         main {
             role: "main",
             div { id: "hero",
-                h1 { "Dioxus Primitives" }
+                h1 { "Dioxus Components" }
                 h2 {
                     b { "Accessible" }
                     ", "

primitives/README.md

@@ -0,0 +1,36 @@
+<div align="center">
+  <h1>🎲 Dioxus Primitives 🧱</h1>
+  <p><strong>Accessible, unstyled, foundational components for Dioxus.</strong></p>
+</div>
+
+<div align="center">
+  <!-- Crates version -->
+  <a href="https://crates.io/crates/dioxus-primitives">
+    <img src="https://img.shields.io/crates/v/dioxus-primitives.svg?style=flat-square"
+    alt="Crates.io version" />
+  </a>
+  <!-- Downloads -->
+  <a href="https://crates.io/crates/dioxus-primitives">
+    <img src="https://img.shields.io/crates/d/dioxus-primitives.svg?style=flat-square"
+      alt="Download" />
+  </a>
+  <!-- docs -->
+  <a href="https://docs.rs/dioxus-primitives">
+    <img src="https://img.shields.io/badge/docs-latest-blue.svg?style=flat-square"
+      alt="docs.rs docs" />
+  </a>
+</div>
+
+---
+
+<br/>
+
+Dioxus primitives is an ARIA-accessible, unstyled, foundational component library for Dioxus based on Radix Primitives. It defines the structure and behavior of components without imposing any specific styles. You can bring your own design patterns and styles to create a consistent look and feel for your application.
+
+If you are looking for a starting point to develop a styled component library for your application, you can use our shadcn-style [dioxus components](https://dioxuslabs.github.io/components) or a community library.
+
+## License
+
+This project is dual licensed under the [MIT](./LICENSE-MIT) and [Apache 2.0](./LICENSE-APACHE) licenses.
+
+Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this repository, by you, shall be licensed as MIT or Apache 2.0, without any additional terms or conditions.