API docs for Material Components (#26)

Author: NigelBreslaw

docs/astro.config.mjs

@@ -28,7 +28,7 @@ export default defineConfig({
     },
     integrations: [
         starlight({
-            title: "Slint Docs",
+            title: "Material UI",
             logo: {
                 src: "./src/assets/slint-logo-small-light.svg",
             },
@@ -44,8 +44,8 @@ export default defineConfig({
                 { label: "Style", link: "style" },
 
                 {
-                    label: "Basic Widgets",
-                    autogenerate: { directory: "basic-widgets" },
+                    label: "Components",
+                    autogenerate: { directory: "components" },
                 },
             ],
             plugins: [

docs/src/content/collections/enums/CheckState.md

@@ -0,0 +1,17 @@
+---
+<!-- Copyright © SixtyFPS GmbH <[email protected]> ; SPDX-License-Identifier: MIT -->
+title: CheckState
+description: CheckState content
+---
+
+<!-- unchecked,
+    partially_checked,
+    checked, -->
+
+`CheckState`
+
+ This enum is used to define the state of a checkbox.
+
+* **`unchecked`**:  The checkbox is unchecked.
+* **`partially_checked`**:  The checkbox is partially checked.
+* **`checked`**:  The checkbox is checked.

docs/src/content/collections/enums/FABStyle.md

@@ -0,0 +1,13 @@
+---
+<!-- Copyright © SixtyFPS GmbH <[email protected]> ; SPDX-License-Identifier: MIT -->
+title: FABStyle
+description: FABStyle content
+---
+
+`FABStyle`
+
+This enum is used to define the style of a Floating Action Button (FAB).
+
+* **`small`**: A small floating action button.
+* **`standard`**: The standard floating action button size.
+* **`large`**: A large floating action button.

docs/src/content/collections/structs/IconButtonItem.md

@@ -0,0 +1,13 @@
+---
+<!-- Copyright © SixtyFPS GmbH <[email protected]> ; SPDX-License-Identifier: MIT -->
+title: IconButtonItem
+description: IconButtonItem content
+---
+
+`IconButtonItem`
+
+This structure represents a IconButtonItem with x and y coordinate
+
+- **`icon`** (_image_): The icon to display in the button.
+- **`tooltip`** (_string_): The tooltip to display when hovering over the button.
+- **`enabled`** (_bool_): Whether the button is enabled.

docs/src/content/collections/structs/SegmentedItem.md

@@ -0,0 +1,12 @@
+---
+<!-- Copyright © SixtyFPS GmbH <[email protected]> ; SPDX-License-Identifier: MIT -->
+title: SegmentedItem
+description: SegmentedItem content
+---
+
+`SegmentedItem`
+
+This structure represents an item in a segmented button control.
+
+- **`icon`** (_image_): The icon to display for the item.
+- **`text`** (_string_): The text label for the item.

docs/src/content/collections/structs/Time.md

@@ -0,0 +1,13 @@
+---
+<!-- Copyright © SixtyFPS GmbH <[email protected]> ; SPDX-License-Identifier: MIT -->
+title: Time
+description: Time content
+---
+
+`Time`
+
+This structure represents a time value with hour, minute, and second fields.
+
+- **`hour`** (_int_): The hour component of the time.
+- **`minute`** (_int_): The minute component of the time.
+- **`second`** (_int_): The second component of the time.