From 5151eb4fe79d17f9f87a5f188781f6c15ab5b35b Mon Sep 17 00:00:00 2001 From: Joe Kawai Date: Wed, 16 Oct 2024 18:02:06 +0800 Subject: [PATCH] Widget Categories for Docs (#223) * Initial categories * Replace links in docs --- docs/pages/docs/_meta.ts | 8 ++++++-- docs/pages/docs/{ => data}/accordion.mdx | 6 +++--- docs/pages/docs/{ => data}/avatar.mdx | 6 +++--- docs/pages/docs/{ => data}/badge.mdx | 6 +++--- docs/pages/docs/{ => data}/card.mdx | 6 +++--- docs/pages/docs/{ => data}/icon.mdx | 6 +++--- docs/pages/docs/{ => feedback}/alert.mdx | 6 +++--- docs/pages/docs/{ => feedback}/progress.mdx | 6 +++--- docs/pages/docs/{ => form}/button.mdx | 6 +++--- docs/pages/docs/{ => form}/calendar.mdx | 6 +++--- docs/pages/docs/{ => form}/checkbox.mdx | 6 +++--- docs/pages/docs/{ => form}/label.mdx | 6 +++--- docs/pages/docs/{ => form}/radio.mdx | 6 +++--- docs/pages/docs/{ => form}/select-group.mdx | 6 +++--- docs/pages/docs/{ => form}/slider.mdx | 6 +++--- docs/pages/docs/{ => form}/switch.mdx | 6 +++--- docs/pages/docs/{ => form}/text-field.mdx | 6 +++--- docs/pages/docs/{ => layout}/divider.mdx | 6 +++--- docs/pages/docs/{ => layout}/resizable.mdx | 6 +++--- docs/pages/docs/{ => layout}/scaffold.mdx | 6 +++--- .../pages/docs/{ => navigation}/bottom-navigation-bar.mdx | 6 +++--- docs/pages/docs/{ => navigation}/header.mdx | 6 +++--- docs/pages/docs/{ => navigation}/tabs.mdx | 6 +++--- docs/pages/docs/{ => overlay}/dialog.mdx | 6 +++--- docs/pages/docs/{ => overlay}/popover.mdx | 6 +++--- docs/pages/docs/{ => overlay}/tooltip.mdx | 7 +++---- forui/lib/src/widgets/accordion/accordion.dart | 2 +- forui/lib/src/widgets/accordion/accordion_item.dart | 2 +- forui/lib/src/widgets/alert.dart | 2 +- forui/lib/src/widgets/avatar/avatar.dart | 3 +++ forui/lib/src/widgets/badge/badge.dart | 2 +- .../bottom_navigation_bar/bottom_navigation_bar.dart | 2 +- forui/lib/src/widgets/button/button.dart | 2 +- forui/lib/src/widgets/calendar/calendar.dart | 2 +- forui/lib/src/widgets/card/card.dart | 2 +- forui/lib/src/widgets/checkbox.dart | 2 +- forui/lib/src/widgets/dialog/dialog.dart | 2 +- forui/lib/src/widgets/divider.dart | 2 +- forui/lib/src/widgets/header/header.dart | 2 +- forui/lib/src/widgets/header/nested_header.dart | 2 +- forui/lib/src/widgets/header/root_header.dart | 2 +- forui/lib/src/widgets/icon.dart | 1 + forui/lib/src/widgets/label.dart | 2 +- forui/lib/src/widgets/popover.dart | 2 +- forui/lib/src/widgets/progress.dart | 2 +- forui/lib/src/widgets/radio.dart | 2 +- forui/lib/src/widgets/resizable/resizable.dart | 2 +- forui/lib/src/widgets/resizable/resizable_controller.dart | 4 ++-- forui/lib/src/widgets/resizable/resizable_region.dart | 2 +- forui/lib/src/widgets/scaffold.dart | 2 +- forui/lib/src/widgets/select_group/select_group.dart | 2 +- forui/lib/src/widgets/slider/slider.dart | 2 +- forui/lib/src/widgets/switch.dart | 2 +- forui/lib/src/widgets/tabs/tabs.dart | 2 +- forui/lib/src/widgets/text_field/text_field.dart | 2 +- forui/lib/src/widgets/tooltip.dart | 2 +- forui/lib/widgets/alert.dart | 2 +- forui/lib/widgets/avatar.dart | 2 +- forui/lib/widgets/badge.dart | 2 +- forui/lib/widgets/bottom_navigation_bar.dart | 2 +- forui/lib/widgets/button.dart | 2 +- forui/lib/widgets/calendar.dart | 2 +- forui/lib/widgets/card.dart | 2 +- forui/lib/widgets/checkbox.dart | 2 +- forui/lib/widgets/dialog.dart | 2 +- forui/lib/widgets/divider.dart | 2 +- forui/lib/widgets/header.dart | 2 +- forui/lib/widgets/icon.dart | 2 +- forui/lib/widgets/label.dart | 2 +- forui/lib/widgets/popover.dart | 2 +- forui/lib/widgets/progress.dart | 2 +- forui/lib/widgets/radio.dart | 2 +- forui/lib/widgets/resizable.dart | 2 +- forui/lib/widgets/scaffold.dart | 2 +- forui/lib/widgets/select_group.dart | 2 +- forui/lib/widgets/slider.dart | 2 +- forui/lib/widgets/switch.dart | 2 +- forui/lib/widgets/tabs.dart | 2 +- forui/lib/widgets/text_field.dart | 2 +- forui/lib/widgets/tooltip.dart | 2 ++ 80 files changed, 139 insertions(+), 130 deletions(-) rename docs/pages/docs/{ => data}/accordion.mdx (95%) rename docs/pages/docs/{ => data}/avatar.mdx (93%) rename docs/pages/docs/{ => data}/badge.mdx (89%) rename docs/pages/docs/{ => data}/card.mdx (84%) rename docs/pages/docs/{ => data}/icon.mdx (95%) rename docs/pages/docs/{ => feedback}/alert.mdx (87%) rename docs/pages/docs/{ => feedback}/progress.mdx (83%) rename docs/pages/docs/{ => form}/button.mdx (93%) rename docs/pages/docs/{ => form}/calendar.mdx (94%) rename docs/pages/docs/{ => form}/checkbox.mdx (96%) rename docs/pages/docs/{ => form}/label.mdx (94%) rename docs/pages/docs/{ => form}/radio.mdx (85%) rename docs/pages/docs/{ => form}/select-group.mdx (96%) rename docs/pages/docs/{ => form}/slider.mdx (98%) rename docs/pages/docs/{ => form}/switch.mdx (97%) rename docs/pages/docs/{ => form}/text-field.mdx (96%) rename docs/pages/docs/{ => layout}/divider.mdx (90%) rename docs/pages/docs/{ => layout}/resizable.mdx (97%) rename docs/pages/docs/{ => layout}/scaffold.mdx (94%) rename docs/pages/docs/{ => navigation}/bottom-navigation-bar.mdx (91%) rename docs/pages/docs/{ => navigation}/header.mdx (95%) rename docs/pages/docs/{ => navigation}/tabs.mdx (91%) rename docs/pages/docs/{ => overlay}/dialog.mdx (95%) rename docs/pages/docs/{ => overlay}/popover.mdx (98%) rename docs/pages/docs/{ => overlay}/tooltip.mdx (90%) diff --git a/docs/pages/docs/_meta.ts b/docs/pages/docs/_meta.ts index 5e9d6c57c..4368807dc 100644 --- a/docs/pages/docs/_meta.ts +++ b/docs/pages/docs/_meta.ts @@ -19,9 +19,13 @@ export default { }, // TODO: Workaround for a seperator bug. Remove when patched. // A page need to be listed after a separator or else the order will be messed up. - accordion: 'Accordion', + layout: 'Layout', + form: 'Form', + data: 'Data Presentation', + navigation: 'Navigation', + feedback: 'Feedback', + overlay: 'Overlay', '*': { title: '' }, - }; diff --git a/docs/pages/docs/accordion.mdx b/docs/pages/docs/data/accordion.mdx similarity index 95% rename from docs/pages/docs/accordion.mdx rename to docs/pages/docs/data/accordion.mdx index afaf5ebe7..bd1af51b0 100644 --- a/docs/pages/docs/accordion.mdx +++ b/docs/pages/docs/data/accordion.mdx @@ -1,7 +1,7 @@ import { Tabs } from 'nextra/components'; -import { Widget } from "../../components/widget"; -import LinkBadge from "../../components/link-badge/link-badge"; -import LinkBadgeGroup from "../../components/link-badge/link-badge-group"; +import { Widget } from "../../../components/widget.tsx"; +import LinkBadge from "../../../components/link-badge/link-badge.tsx"; +import LinkBadgeGroup from "../../../components/link-badge/link-badge-group.tsx"; # Accordion A vertically stacked set of interactive headings that each reveal a section of content. diff --git a/docs/pages/docs/avatar.mdx b/docs/pages/docs/data/avatar.mdx similarity index 93% rename from docs/pages/docs/avatar.mdx rename to docs/pages/docs/data/avatar.mdx index ab743cb03..e544b9fab 100644 --- a/docs/pages/docs/avatar.mdx +++ b/docs/pages/docs/data/avatar.mdx @@ -1,7 +1,7 @@ import { Tabs } from 'nextra/components'; -import { Widget } from "../../components/widget"; -import LinkBadge from "../../components/link-badge/link-badge"; -import LinkBadgeGroup from "../../components/link-badge/link-badge-group"; +import { Widget } from "../../../components/widget.tsx"; +import LinkBadge from "../../../components/link-badge/link-badge.tsx"; +import LinkBadgeGroup from "../../../components/link-badge/link-badge-group.tsx"; # Avatar An image element with a fallback for representing the user. diff --git a/docs/pages/docs/badge.mdx b/docs/pages/docs/data/badge.mdx similarity index 89% rename from docs/pages/docs/badge.mdx rename to docs/pages/docs/data/badge.mdx index 6beb5a172..ce5548da5 100644 --- a/docs/pages/docs/badge.mdx +++ b/docs/pages/docs/data/badge.mdx @@ -1,7 +1,7 @@ import { Tabs } from 'nextra/components'; -import { Widget } from "../../components/widget"; -import LinkBadge from "../../components/link-badge/link-badge"; -import LinkBadgeGroup from "../../components/link-badge/link-badge-group"; +import { Widget } from "../../../components/widget.tsx"; +import LinkBadge from "../../../components/link-badge/link-badge.tsx"; +import LinkBadgeGroup from "../../../components/link-badge/link-badge-group.tsx"; # Badge A badge typically draws attention to specific information, such as labels and counts. diff --git a/docs/pages/docs/card.mdx b/docs/pages/docs/data/card.mdx similarity index 84% rename from docs/pages/docs/card.mdx rename to docs/pages/docs/data/card.mdx index e453184d8..dbe0e82a5 100644 --- a/docs/pages/docs/card.mdx +++ b/docs/pages/docs/data/card.mdx @@ -1,7 +1,7 @@ import { Tabs } from 'nextra/components'; -import { Widget } from "../../components/widget"; -import LinkBadge from "../../components/link-badge/link-badge"; -import LinkBadgeGroup from "../../components/link-badge/link-badge-group"; +import { Widget } from "../../../components/widget.tsx"; +import LinkBadge from "../../../components/link-badge/link-badge.tsx"; +import LinkBadgeGroup from "../../../components/link-badge/link-badge-group.tsx"; # Card A card, typically with a title, subtitle, and child widget. diff --git a/docs/pages/docs/icon.mdx b/docs/pages/docs/data/icon.mdx similarity index 95% rename from docs/pages/docs/icon.mdx rename to docs/pages/docs/data/icon.mdx index cd5e70567..b4f4b8fc3 100644 --- a/docs/pages/docs/icon.mdx +++ b/docs/pages/docs/data/icon.mdx @@ -1,8 +1,8 @@ import { Tabs } from 'nextra/components'; import { Callout } from "nextra/components"; -import { Widget } from "../../components/widget"; -import LinkBadge from "../../components/link-badge/link-badge"; -import LinkBadgeGroup from "../../components/link-badge/link-badge-group"; +import { Widget } from "../../../components/widget.tsx"; +import LinkBadge from "../../../components/link-badge/link-badge.tsx"; +import LinkBadgeGroup from "../../../components/link-badge/link-badge-group.tsx"; # Icon An icon that inherits its style from an enclosing, supported widget, such as a [button](/docs/button). diff --git a/docs/pages/docs/alert.mdx b/docs/pages/docs/feedback/alert.mdx similarity index 87% rename from docs/pages/docs/alert.mdx rename to docs/pages/docs/feedback/alert.mdx index 25e49497f..794f401c4 100644 --- a/docs/pages/docs/alert.mdx +++ b/docs/pages/docs/feedback/alert.mdx @@ -1,7 +1,7 @@ import { Tabs } from 'nextra/components'; -import { Widget } from "../../components/widget"; -import LinkBadge from "../../components/link-badge/link-badge"; -import LinkBadgeGroup from "../../components/link-badge/link-badge-group"; +import { Widget } from "../../../components/widget.tsx"; +import LinkBadge from "../../../components/link-badge/link-badge.tsx"; +import LinkBadgeGroup from "../../../components/link-badge/link-badge-group.tsx"; # Alert Displays a callout for user attention. diff --git a/docs/pages/docs/progress.mdx b/docs/pages/docs/feedback/progress.mdx similarity index 83% rename from docs/pages/docs/progress.mdx rename to docs/pages/docs/feedback/progress.mdx index a965d318d..4d72f4011 100644 --- a/docs/pages/docs/progress.mdx +++ b/docs/pages/docs/feedback/progress.mdx @@ -1,7 +1,7 @@ import { Tabs } from 'nextra/components'; -import { Widget } from "../../components/widget"; -import LinkBadge from "../../components/link-badge/link-badge"; -import LinkBadgeGroup from "../../components/link-badge/link-badge-group"; +import { Widget } from "../../../components/widget.tsx"; +import LinkBadge from "../../../components/link-badge/link-badge.tsx"; +import LinkBadgeGroup from "../../../components/link-badge/link-badge-group.tsx"; # Progress Displays an indicator showing the completion progress of a task, typically displayed as a progress bar. diff --git a/docs/pages/docs/button.mdx b/docs/pages/docs/form/button.mdx similarity index 93% rename from docs/pages/docs/button.mdx rename to docs/pages/docs/form/button.mdx index 38600a6fd..a55089c38 100644 --- a/docs/pages/docs/button.mdx +++ b/docs/pages/docs/form/button.mdx @@ -1,7 +1,7 @@ import { Tabs } from 'nextra/components'; -import { Widget } from "../../components/widget"; -import LinkBadge from "../../components/link-badge/link-badge"; -import LinkBadgeGroup from "../../components/link-badge/link-badge-group"; +import { Widget } from "../../../components/widget.tsx"; +import LinkBadge from "../../../components/link-badge/link-badge.tsx"; +import LinkBadgeGroup from "../../../components/link-badge/link-badge-group.tsx"; # Button A button. diff --git a/docs/pages/docs/calendar.mdx b/docs/pages/docs/form/calendar.mdx similarity index 94% rename from docs/pages/docs/calendar.mdx rename to docs/pages/docs/form/calendar.mdx index ceee7d36b..48585331c 100644 --- a/docs/pages/docs/calendar.mdx +++ b/docs/pages/docs/form/calendar.mdx @@ -1,7 +1,7 @@ import { Tabs } from 'nextra/components'; -import { Widget } from "../../components/widget"; -import LinkBadge from "../../components/link-badge/link-badge"; -import LinkBadgeGroup from "../../components/link-badge/link-badge-group"; +import { Widget } from "../../../components/widget.tsx"; +import LinkBadge from "../../../components/link-badge/link-badge.tsx"; +import LinkBadgeGroup from "../../../components/link-badge/link-badge-group.tsx"; # Calendar A date field component that allows users to enter and edit date. diff --git a/docs/pages/docs/checkbox.mdx b/docs/pages/docs/form/checkbox.mdx similarity index 96% rename from docs/pages/docs/checkbox.mdx rename to docs/pages/docs/form/checkbox.mdx index 631b2838d..6cc6fce04 100644 --- a/docs/pages/docs/checkbox.mdx +++ b/docs/pages/docs/form/checkbox.mdx @@ -1,7 +1,7 @@ import {Callout, Tabs} from 'nextra/components'; -import { Widget } from "../../components/widget"; -import LinkBadge from "../../components/link-badge/link-badge"; -import LinkBadgeGroup from "../../components/link-badge/link-badge-group"; +import { Widget } from "../../../components/widget.tsx"; +import LinkBadge from "../../../components/link-badge/link-badge.tsx"; +import LinkBadgeGroup from "../../../components/link-badge/link-badge-group.tsx"; # Checkbox A control that allows the user to toggle between checked and not checked. diff --git a/docs/pages/docs/label.mdx b/docs/pages/docs/form/label.mdx similarity index 94% rename from docs/pages/docs/label.mdx rename to docs/pages/docs/form/label.mdx index 530342f6b..1c76cf996 100644 --- a/docs/pages/docs/label.mdx +++ b/docs/pages/docs/form/label.mdx @@ -1,7 +1,7 @@ import { Tabs } from 'nextra/components'; -import { Widget } from "../../components/widget"; -import LinkBadge from "../../components/link-badge/link-badge"; -import LinkBadgeGroup from "../../components/link-badge/link-badge-group"; +import { Widget } from "../../../components/widget.tsx"; +import LinkBadge from "../../../components/link-badge/link-badge.tsx"; +import LinkBadgeGroup from "../../../components/link-badge/link-badge-group.tsx"; # Label Describes a form field with a label, description, and error message (if any). This widget is usually used for custom diff --git a/docs/pages/docs/radio.mdx b/docs/pages/docs/form/radio.mdx similarity index 85% rename from docs/pages/docs/radio.mdx rename to docs/pages/docs/form/radio.mdx index b28335645..bf04d0a93 100644 --- a/docs/pages/docs/radio.mdx +++ b/docs/pages/docs/form/radio.mdx @@ -1,7 +1,7 @@ import {Callout, Tabs} from 'nextra/components'; -import { Widget } from "../../components/widget"; -import LinkBadge from "../../components/link-badge/link-badge"; -import LinkBadgeGroup from "../../components/link-badge/link-badge-group"; +import { Widget } from "../../../components/widget.tsx"; +import LinkBadge from "../../../components/link-badge/link-badge.tsx"; +import LinkBadgeGroup from "../../../components/link-badge/link-badge-group.tsx"; # Radio A radio button that typically allows the user to choose only one of a predefined set of options. diff --git a/docs/pages/docs/select-group.mdx b/docs/pages/docs/form/select-group.mdx similarity index 96% rename from docs/pages/docs/select-group.mdx rename to docs/pages/docs/form/select-group.mdx index b48d0ca5d..cf4309a0e 100644 --- a/docs/pages/docs/select-group.mdx +++ b/docs/pages/docs/form/select-group.mdx @@ -1,7 +1,7 @@ import {Tabs} from 'nextra/components'; -import { Widget } from "../../components/widget"; -import LinkBadge from "../../components/link-badge/link-badge"; -import LinkBadgeGroup from "../../components/link-badge/link-badge-group"; +import { Widget } from "../../../components/widget.tsx"; +import LinkBadge from "../../../components/link-badge/link-badge.tsx"; +import LinkBadgeGroup from "../../../components/link-badge/link-badge-group.tsx"; # Select Group A set of items that are treated as a single selection. diff --git a/docs/pages/docs/slider.mdx b/docs/pages/docs/form/slider.mdx similarity index 98% rename from docs/pages/docs/slider.mdx rename to docs/pages/docs/form/slider.mdx index 2f04cc4d6..c75764f76 100644 --- a/docs/pages/docs/slider.mdx +++ b/docs/pages/docs/form/slider.mdx @@ -1,7 +1,7 @@ import { Tabs } from 'nextra/components'; -import { Widget } from "../../components/widget"; -import LinkBadge from "../../components/link-badge/link-badge"; -import LinkBadgeGroup from "../../components/link-badge/link-badge-group"; +import { Widget } from "../../../components/widget.tsx"; +import LinkBadge from "../../../components/link-badge/link-badge.tsx"; +import LinkBadgeGroup from "../../../components/link-badge/link-badge-group.tsx"; # Slider An input where the user selects a value from within a given range. diff --git a/docs/pages/docs/switch.mdx b/docs/pages/docs/form/switch.mdx similarity index 97% rename from docs/pages/docs/switch.mdx rename to docs/pages/docs/form/switch.mdx index 0572d45df..5c8e53af2 100644 --- a/docs/pages/docs/switch.mdx +++ b/docs/pages/docs/form/switch.mdx @@ -1,7 +1,7 @@ import { Tabs } from 'nextra/components'; -import { Widget } from "../../components/widget"; -import LinkBadge from "../../components/link-badge/link-badge"; -import LinkBadgeGroup from "../../components/link-badge/link-badge-group"; +import { Widget } from "../../../components/widget.tsx"; +import LinkBadge from "../../../components/link-badge/link-badge.tsx"; +import LinkBadgeGroup from "../../../components/link-badge/link-badge-group.tsx"; # Switch A switch that allows the user to toggle between checked and unchecked. diff --git a/docs/pages/docs/text-field.mdx b/docs/pages/docs/form/text-field.mdx similarity index 96% rename from docs/pages/docs/text-field.mdx rename to docs/pages/docs/form/text-field.mdx index ec5cff7ad..8484e3ebc 100644 --- a/docs/pages/docs/text-field.mdx +++ b/docs/pages/docs/form/text-field.mdx @@ -1,7 +1,7 @@ import { Tabs } from 'nextra/components'; -import { Widget } from '../../components/widget'; -import LinkBadge from "../../components/link-badge/link-badge"; -import LinkBadgeGroup from "../../components/link-badge/link-badge-group"; +import { Widget } from '../../../components/widget.tsx'; +import LinkBadge from "../../../components/link-badge/link-badge.tsx"; +import LinkBadgeGroup from "../../../components/link-badge/link-badge-group.tsx"; # Text Field A text field lets the user enter text, either with hardware keyboard or with an onscreen keyboard. It can also be used diff --git a/docs/pages/docs/divider.mdx b/docs/pages/docs/layout/divider.mdx similarity index 90% rename from docs/pages/docs/divider.mdx rename to docs/pages/docs/layout/divider.mdx index d60260c39..157365953 100644 --- a/docs/pages/docs/divider.mdx +++ b/docs/pages/docs/layout/divider.mdx @@ -1,7 +1,7 @@ import { Tabs } from 'nextra/components'; -import { Widget } from "../../components/widget"; -import LinkBadge from "../../components/link-badge/link-badge"; -import LinkBadgeGroup from "../../components/link-badge/link-badge-group"; +import { Widget } from "../../../components/widget.tsx"; +import LinkBadge from "../../../components/link-badge/link-badge.tsx"; +import LinkBadgeGroup from "../../../components/link-badge/link-badge-group.tsx"; # Divider Visually or semantically separates content. diff --git a/docs/pages/docs/resizable.mdx b/docs/pages/docs/layout/resizable.mdx similarity index 97% rename from docs/pages/docs/resizable.mdx rename to docs/pages/docs/layout/resizable.mdx index ac6448cc2..3bede18d5 100644 --- a/docs/pages/docs/resizable.mdx +++ b/docs/pages/docs/layout/resizable.mdx @@ -1,7 +1,7 @@ import { Tabs } from 'nextra/components'; -import { Widget } from "../../components/widget"; -import LinkBadge from "../../components/link-badge/link-badge"; -import LinkBadgeGroup from "../../components/link-badge/link-badge-group"; +import { Widget } from "../../../components/widget.tsx"; +import LinkBadge from "../../../components/link-badge/link-badge.tsx"; +import LinkBadgeGroup from "../../../components/link-badge/link-badge-group.tsx"; # Resizable A box which children can be resized along either the horizontal or vertical axis. diff --git a/docs/pages/docs/scaffold.mdx b/docs/pages/docs/layout/scaffold.mdx similarity index 94% rename from docs/pages/docs/scaffold.mdx rename to docs/pages/docs/layout/scaffold.mdx index 100ef5bcc..7d5240479 100644 --- a/docs/pages/docs/scaffold.mdx +++ b/docs/pages/docs/layout/scaffold.mdx @@ -1,7 +1,7 @@ import { Tabs } from 'nextra/components'; -import { Widget } from "../../components/widget"; -import LinkBadge from "../../components/link-badge/link-badge"; -import LinkBadgeGroup from "../../components/link-badge/link-badge-group"; +import { Widget } from "../../../components/widget.tsx"; +import LinkBadge from "../../../components/link-badge/link-badge.tsx"; +import LinkBadgeGroup from "../../../components/link-badge/link-badge-group.tsx"; # Scaffold Creates a visual scaffold for Forui widgets. diff --git a/docs/pages/docs/bottom-navigation-bar.mdx b/docs/pages/docs/navigation/bottom-navigation-bar.mdx similarity index 91% rename from docs/pages/docs/bottom-navigation-bar.mdx rename to docs/pages/docs/navigation/bottom-navigation-bar.mdx index ffd74245a..a71c6c2cc 100644 --- a/docs/pages/docs/bottom-navigation-bar.mdx +++ b/docs/pages/docs/navigation/bottom-navigation-bar.mdx @@ -1,8 +1,8 @@ import {Callout} from "nextra/components"; import { Tabs } from 'nextra/components'; -import { Widget } from "../../components/widget"; -import LinkBadge from "../../components/link-badge/link-badge"; -import LinkBadgeGroup from "../../components/link-badge/link-badge-group"; +import { Widget } from "../../../components/widget.tsx"; +import LinkBadge from "../../../components/link-badge/link-badge.tsx"; +import LinkBadgeGroup from "../../../components/link-badge/link-badge-group.tsx"; # Bottom Navigation Bar A bottom navigation bar is usually present at the bottom of root pages. diff --git a/docs/pages/docs/header.mdx b/docs/pages/docs/navigation/header.mdx similarity index 95% rename from docs/pages/docs/header.mdx rename to docs/pages/docs/navigation/header.mdx index 4e946a484..b2cab53e3 100644 --- a/docs/pages/docs/header.mdx +++ b/docs/pages/docs/navigation/header.mdx @@ -1,7 +1,7 @@ import {Callout, Tabs} from 'nextra/components'; -import { Widget } from "../../components/widget"; -import LinkBadge from "../../components/link-badge/link-badge"; -import LinkBadgeGroup from "../../components/link-badge/link-badge-group"; +import { Widget } from "../../../components/widget.tsx"; +import LinkBadge from "../../../components/link-badge/link-badge.tsx"; +import LinkBadgeGroup from "../../../components/link-badge/link-badge-group.tsx"; # Header A header contains the page's title and navigation actions. diff --git a/docs/pages/docs/tabs.mdx b/docs/pages/docs/navigation/tabs.mdx similarity index 91% rename from docs/pages/docs/tabs.mdx rename to docs/pages/docs/navigation/tabs.mdx index 851240148..5a0711b5e 100644 --- a/docs/pages/docs/tabs.mdx +++ b/docs/pages/docs/navigation/tabs.mdx @@ -1,7 +1,7 @@ import { Tabs } from 'nextra/components'; -import { Widget } from "../../components/widget"; -import LinkBadge from "../../components/link-badge/link-badge"; -import LinkBadgeGroup from "../../components/link-badge/link-badge-group"; +import { Widget } from "../../../components/widget.tsx"; +import LinkBadge from "../../../components/link-badge/link-badge.tsx"; +import LinkBadgeGroup from "../../../components/link-badge/link-badge-group.tsx"; # Tabs A set of layered sections of content—known as tab entries—that are displayed one at a time. diff --git a/docs/pages/docs/dialog.mdx b/docs/pages/docs/overlay/dialog.mdx similarity index 95% rename from docs/pages/docs/dialog.mdx rename to docs/pages/docs/overlay/dialog.mdx index b0791e9da..de9ad9687 100644 --- a/docs/pages/docs/dialog.mdx +++ b/docs/pages/docs/overlay/dialog.mdx @@ -1,7 +1,7 @@ import { Tabs } from 'nextra/components'; -import { Widget } from "../../components/widget"; -import LinkBadge from "../../components/link-badge/link-badge"; -import LinkBadgeGroup from "../../components/link-badge/link-badge-group"; +import { Widget } from "../../../components/widget.tsx"; +import LinkBadge from "../../../components/link-badge/link-badge.tsx"; +import LinkBadgeGroup from "../../../components/link-badge/link-badge-group.tsx"; # Dialog A modal dialog interrupts the user with important content and expects a response. diff --git a/docs/pages/docs/popover.mdx b/docs/pages/docs/overlay/popover.mdx similarity index 98% rename from docs/pages/docs/popover.mdx rename to docs/pages/docs/overlay/popover.mdx index 780170637..54142ddc8 100644 --- a/docs/pages/docs/popover.mdx +++ b/docs/pages/docs/overlay/popover.mdx @@ -1,7 +1,7 @@ import { Tabs } from 'nextra/components'; -import { Widget } from "../../components/widget"; -import LinkBadge from "../../components/link-badge/link-badge"; -import LinkBadgeGroup from "../../components/link-badge/link-badge-group"; +import { Widget } from "../../../components/widget.tsx"; +import LinkBadge from "../../../components/link-badge/link-badge.tsx"; +import LinkBadgeGroup from "../../../components/link-badge/link-badge-group.tsx"; # Popover A popover displays rich content in a portal that is aligned to a target. diff --git a/docs/pages/docs/tooltip.mdx b/docs/pages/docs/overlay/tooltip.mdx similarity index 90% rename from docs/pages/docs/tooltip.mdx rename to docs/pages/docs/overlay/tooltip.mdx index 65d9f9c38..28f6835a7 100644 --- a/docs/pages/docs/tooltip.mdx +++ b/docs/pages/docs/overlay/tooltip.mdx @@ -1,8 +1,7 @@ -import { Callout } from "nextra/components"; import { Tabs } from 'nextra/components'; -import { Widget } from "../../components/widget"; -import LinkBadge from "../../components/link-badge/link-badge"; -import LinkBadgeGroup from "../../components/link-badge/link-badge-group"; +import { Widget } from "../../../components/widget.tsx"; +import LinkBadge from "../../../components/link-badge/link-badge.tsx"; +import LinkBadgeGroup from "../../../components/link-badge/link-badge-group.tsx"; # Tooltip A tooltip displays information related to a widget when focused, hovered over, and/or long pressed. diff --git a/forui/lib/src/widgets/accordion/accordion.dart b/forui/lib/src/widgets/accordion/accordion.dart index 2cbd0a12a..306282747 100644 --- a/forui/lib/src/widgets/accordion/accordion.dart +++ b/forui/lib/src/widgets/accordion/accordion.dart @@ -8,7 +8,7 @@ import 'package:forui/forui.dart'; /// A vertically stacked set of interactive headings that each reveal a section of content. /// /// See: -/// * https://forui.dev/docs/accordion for working examples. +/// * https://forui.dev/docs/data/accordion for working examples. /// * [FAccordionController] for customizing the accordion's behavior. /// * [FAccordionItem] for adding items to an accordion. /// * [FAccordionStyle] for customizing an accordion's appearance. diff --git a/forui/lib/src/widgets/accordion/accordion_item.dart b/forui/lib/src/widgets/accordion/accordion_item.dart index 0b1087160..0bf00ed75 100644 --- a/forui/lib/src/widgets/accordion/accordion_item.dart +++ b/forui/lib/src/widgets/accordion/accordion_item.dart @@ -11,7 +11,7 @@ import 'package:forui/src/widgets/accordion/accordion.dart'; /// An interactive heading that reveals a section of content. /// /// See: -/// * https://forui.dev/docs/accordion for working examples. +/// * https://forui.dev/docs/data/accordion for working examples. class FAccordionItem extends StatefulWidget { /// The accordion's style. Defaults to [FThemeData.accordionStyle]. final FAccordionStyle? style; diff --git a/forui/lib/src/widgets/alert.dart b/forui/lib/src/widgets/alert.dart index ea187e916..753ae1008 100644 --- a/forui/lib/src/widgets/alert.dart +++ b/forui/lib/src/widgets/alert.dart @@ -10,7 +10,7 @@ import 'package:forui/forui.dart'; /// Displays a callout for user attention. /// /// See: -/// * https://forui.dev/docs/alert for working examples. +/// * https://forui.dev/docs/navigation/alert for working examples. /// * [FAlertStyle] for customizing an alert's appearance. class FAlert extends StatelessWidget { /// The icon. Defaults to [FAssets.icons.circleAlert]. diff --git a/forui/lib/src/widgets/avatar/avatar.dart b/forui/lib/src/widgets/avatar/avatar.dart index c4a6c9d98..eb94165db 100644 --- a/forui/lib/src/widgets/avatar/avatar.dart +++ b/forui/lib/src/widgets/avatar/avatar.dart @@ -13,6 +13,9 @@ import 'package:forui/src/widgets/avatar/avatar_content.dart'; /// /// If the user's profile has no image, use the fallback property to display the initials using a [Text] widget styled /// with [FAvatarStyle.backgroundColor]. +/// +/// See: +/// * https://forui.dev/docs/data/avatar for working examples. class FAvatar extends StatelessWidget { /// The style. Defaults to [FThemeData.avatarStyle]. final FAvatarStyle? style; diff --git a/forui/lib/src/widgets/badge/badge.dart b/forui/lib/src/widgets/badge/badge.dart index 894b3d83d..8e1a1cfaf 100644 --- a/forui/lib/src/widgets/badge/badge.dart +++ b/forui/lib/src/widgets/badge/badge.dart @@ -11,7 +11,7 @@ import 'package:forui/src/widgets/badge/badge_content.dart'; /// The constants in [FBadgeStyle] provide a convenient way to style a badge. /// /// See: -/// * https://forui.dev/docs/badge for working examples. +/// * https://forui.dev/docs/data/badge for working examples. /// * [FBadgeCustomStyle] for customizing a badge's appearance. class FBadge extends StatelessWidget { /// The style. Defaults to [FBadgeStyle.primary]. diff --git a/forui/lib/src/widgets/bottom_navigation_bar/bottom_navigation_bar.dart b/forui/lib/src/widgets/bottom_navigation_bar/bottom_navigation_bar.dart index bcbbe0e54..33e6075f0 100644 --- a/forui/lib/src/widgets/bottom_navigation_bar/bottom_navigation_bar.dart +++ b/forui/lib/src/widgets/bottom_navigation_bar/bottom_navigation_bar.dart @@ -12,7 +12,7 @@ import 'package:forui/src/foundation/tappable.dart'; /// number of views, typically between three and five. /// /// See: -/// * https://forui.dev/docs/bottom-navigation-bar for working examples. +/// * https://forui.dev/docs/navigation/bottom-navigation-bar for working examples. /// * [FBottomNavigationBarStyle] for customizing a bottom navigation bar's appearance. /// * [FBottomNavigationBarItem] for the items in a bottom navigation bar. class FBottomNavigationBar extends StatelessWidget { diff --git a/forui/lib/src/widgets/button/button.dart b/forui/lib/src/widgets/button/button.dart index de366debd..136b305a3 100644 --- a/forui/lib/src/widgets/button/button.dart +++ b/forui/lib/src/widgets/button/button.dart @@ -15,7 +15,7 @@ import 'package:forui/src/widgets/button/button_content.dart'; /// The constants in [FButtonStyle] provide a convenient way to style a badge. /// /// See: -/// * https://forui.dev/docs/button for working examples. +/// * https://forui.dev/docs/form/button for working examples. /// * [FButtonCustomStyle] for customizing a button's appearance. class FButton extends StatelessWidget { /// The style. Defaults to [FButtonStyle.primary]. diff --git a/forui/lib/src/widgets/calendar/calendar.dart b/forui/lib/src/widgets/calendar/calendar.dart index 47840f879..64cb4f6ad 100644 --- a/forui/lib/src/widgets/calendar/calendar.dart +++ b/forui/lib/src/widgets/calendar/calendar.dart @@ -19,7 +19,7 @@ import 'package:forui/src/widgets/calendar/year_month_picker.dart'; /// [DateTime]s outside [start] and [end] are unselectable regardless of the [FCalendarController] used. /// /// See: -/// * https://forui.dev/docs/calendar for working examples. +/// * https://forui.dev/docs/form/calendar for working examples. /// * [FCalendarController] for customizing a calendar's date selection behavior. /// * [FCalendarStyle] for customizing a calendar's appearance. class FCalendar extends StatelessWidget { diff --git a/forui/lib/src/widgets/card/card.dart b/forui/lib/src/widgets/card/card.dart index 03b78aac5..95cf015a1 100644 --- a/forui/lib/src/widgets/card/card.dart +++ b/forui/lib/src/widgets/card/card.dart @@ -11,7 +11,7 @@ import 'package:forui/src/widgets/card/card_content.dart'; /// Card are typically used to group related information together. /// /// See: -/// * https://forui.dev/docs/card for working examples. +/// * https://forui.dev/docs/data/card for working examples. /// * [FCardStyle] for customizing a card's appearance. final class FCard extends StatelessWidget { /// The style. Defaults to [FThemeData.cardStyle]. diff --git a/forui/lib/src/widgets/checkbox.dart b/forui/lib/src/widgets/checkbox.dart index fbebf107f..b46539e2e 100644 --- a/forui/lib/src/widgets/checkbox.dart +++ b/forui/lib/src/widgets/checkbox.dart @@ -11,7 +11,7 @@ import 'package:forui/forui.dart'; /// For touch devices, a [FSwitch] is generally recommended over a [FCheckbox]. /// /// See: -/// * https://forui.dev/docs/checkbox for working examples. +/// * https://forui.dev/docs/form/checkbox for working examples. /// * [FCheckboxStyle] for customizing a checkbox's appearance. class FCheckbox extends StatelessWidget { /// The style. Defaults to [FThemeData.checkboxStyle]. diff --git a/forui/lib/src/widgets/dialog/dialog.dart b/forui/lib/src/widgets/dialog/dialog.dart index 20bc9e33b..6c409a433 100644 --- a/forui/lib/src/widgets/dialog/dialog.dart +++ b/forui/lib/src/widgets/dialog/dialog.dart @@ -13,7 +13,7 @@ import 'package:forui/src/widgets/dialog/dialog_content.dart'; /// [showAdaptiveDialog] and [showDialog]. /// /// See: -/// * https://forui.dev/docs/dialog for working examples. +/// * https://forui.dev/docs/overlay/dialog for working examples. /// * [FDialogStyle] for customizing a dialog's appearance. class FDialog extends StatelessWidget { static const _defaultDuration = Duration(milliseconds: 100); diff --git a/forui/lib/src/widgets/divider.dart b/forui/lib/src/widgets/divider.dart index b3fe990cb..7708fcb82 100644 --- a/forui/lib/src/widgets/divider.dart +++ b/forui/lib/src/widgets/divider.dart @@ -10,7 +10,7 @@ import 'package:forui/forui.dart'; /// Dividers visually separate content. /// /// See: -/// * https://forui.dev/docs/divider for working examples. +/// * https://forui.dev/docs/layout/divider for working examples. /// * [FDividerStyle] for customizing a divider's appearance. final class FDivider extends StatelessWidget { /// The divider's style. Defaults to the appropriate style in [FThemeData.dividerStyles]. diff --git a/forui/lib/src/widgets/header/header.dart b/forui/lib/src/widgets/header/header.dart index 787d2a603..b1e4d1e0e 100644 --- a/forui/lib/src/widgets/header/header.dart +++ b/forui/lib/src/widgets/header/header.dart @@ -15,7 +15,7 @@ part 'nested_header.dart'; /// A header contains the page's title and actions. /// /// See: -/// * https://forui.dev/docs/header for working examples. +/// * https://forui.dev/docs/navigation/header for working examples. /// * [FRootHeaderStyle] and [FNestedHeaderStyle] for customizing a header's appearance. sealed class FHeader extends StatelessWidget { const FHeader._({super.key}); diff --git a/forui/lib/src/widgets/header/nested_header.dart b/forui/lib/src/widgets/header/nested_header.dart index 09324d333..fa325f354 100644 --- a/forui/lib/src/widgets/header/nested_header.dart +++ b/forui/lib/src/widgets/header/nested_header.dart @@ -6,7 +6,7 @@ part of 'header.dart'; /// It is typically used on pages that are not at the root of the navigation stack. /// /// See: -/// * https://forui.dev/docs/header for working examples. +/// * https://forui.dev/docs/navigation/header for working examples. /// * [FNestedHeaderStyle] for customizing a header's appearance. final class _FNestedHeader extends FHeader { /// The style. Defaults to [FThemeData.headerStyle.nestedStyle]. diff --git a/forui/lib/src/widgets/header/root_header.dart b/forui/lib/src/widgets/header/root_header.dart index 2f0a90673..c81dcafdf 100644 --- a/forui/lib/src/widgets/header/root_header.dart +++ b/forui/lib/src/widgets/header/root_header.dart @@ -6,7 +6,7 @@ part of 'header.dart'; /// It is typically used on pages at the root of the navigation stack. /// /// See: -/// * https://forui.dev/docs/header for working examples. +/// * https://forui.dev/docs/navigation/header for working examples. /// * [FRootHeaderStyle] for customizing a header's appearance. final class _FRootHeader extends FHeader { /// The header's style. Defaults to [FThemeData.headerStyle.rootStyle]. diff --git a/forui/lib/src/widgets/icon.dart b/forui/lib/src/widgets/icon.dart index a0e3dd52c..fd26b0472 100644 --- a/forui/lib/src/widgets/icon.dart +++ b/forui/lib/src/widgets/icon.dart @@ -63,6 +63,7 @@ class FIconStyle with Diagnosticable { /// [FStyle.iconStyle] otherwise. /// /// See: +/// * https://forui.dev/docs/data/icon for working examples. /// * [FIconStyle] for the properties that can be inherited. /// * [FAssets.icons] for bundled Forui icons. abstract class FIcon extends StatelessWidget { diff --git a/forui/lib/src/widgets/label.dart b/forui/lib/src/widgets/label.dart index 6d8a0c1a5..cf059d542 100644 --- a/forui/lib/src/widgets/label.dart +++ b/forui/lib/src/widgets/label.dart @@ -43,7 +43,7 @@ enum FLabelState { /// ``` /// /// See: -/// * https://forui.dev/docs/label for working examples. +/// * https://forui.dev/docs/form/label for working examples. /// * [FLabelStyles] for customizing a label's appearance. final class FLabel extends StatelessWidget { /// The label's style. Defaults to the appropriate style in [FThemeData.labelStyles]. diff --git a/forui/lib/src/widgets/popover.dart b/forui/lib/src/widgets/popover.dart index 742852612..b39d9b15b 100644 --- a/forui/lib/src/widgets/popover.dart +++ b/forui/lib/src/widgets/popover.dart @@ -66,7 +66,7 @@ final class FPopoverController extends FChangeNotifier { /// A popover displays rich content in a portal that is aligned to a target. /// /// See: -/// * https://forui.dev/docs/popover for working examples. +/// * https://forui.dev/docs/overlay/popover for working examples. /// * [FPopoverController] for controlling a popover. /// * [FPopoverStyle] for customizing a popover's appearance. class FPopover extends StatefulWidget { diff --git a/forui/lib/src/widgets/progress.dart b/forui/lib/src/widgets/progress.dart index 5f3875f2e..4b95452b2 100644 --- a/forui/lib/src/widgets/progress.dart +++ b/forui/lib/src/widgets/progress.dart @@ -10,7 +10,7 @@ import 'package:forui/forui.dart'; /// Displays an indicator showing the completion progress of a task, typically displayed as a progress bar. /// /// See: -/// * https://forui.dev/docs/progress for working examples. +/// * https://forui.dev/docs/navigation/progress for working examples. /// * [FProgressStyle] for customizing a progress's appearance. class FProgress extends StatelessWidget { /// The style. Defaults to [FThemeData.progressStyle]. diff --git a/forui/lib/src/widgets/radio.dart b/forui/lib/src/widgets/radio.dart index dc40bf119..60aeacd5b 100644 --- a/forui/lib/src/widgets/radio.dart +++ b/forui/lib/src/widgets/radio.dart @@ -11,7 +11,7 @@ import 'package:forui/forui.dart'; /// buttons. /// /// See: -/// * https://forui.dev/docs/radio for working examples. +/// * https://forui.dev/docs/form/radio for working examples. /// * [FRadioStyle] for customizing a radio's appearance. class FRadio extends StatelessWidget { /// The style. Defaults to [FThemeData.radioStyle]. diff --git a/forui/lib/src/widgets/resizable/resizable.dart b/forui/lib/src/widgets/resizable/resizable.dart index 2cc087d57..435796aee 100644 --- a/forui/lib/src/widgets/resizable/resizable.dart +++ b/forui/lib/src/widgets/resizable/resizable.dart @@ -17,7 +17,7 @@ import 'package:forui/src/widgets/resizable/divider.dart'; /// It is recommended that a [FResizable] contains at least 2 [FResizableRegion]s. /// /// See: -/// * https://forui.dev/docs/resizable for working examples. +/// * https://forui.dev/docs/layout/resizable for working examples. /// * [FResizableStyle] for customizing a resizable's appearance. class FResizable extends StatefulWidget { static String _label(FResizableRegionData left, FResizableRegionData right) => diff --git a/forui/lib/src/widgets/resizable/resizable_controller.dart b/forui/lib/src/widgets/resizable/resizable_controller.dart index 8e0a9324f..f180a2e86 100644 --- a/forui/lib/src/widgets/resizable/resizable_controller.dart +++ b/forui/lib/src/widgets/resizable/resizable_controller.dart @@ -37,7 +37,7 @@ abstract interface class FResizableController extends FChangeNotifier { /// /// [onResizeEnd] is called after a resizable region and its neighbours have been resized. /// - /// See https://forui.dev/docs/resizable#no-cascading for a working example. + /// See https://forui.dev/docs/layout/resizable#no-cascading for a working example. factory FResizableController({ void Function(List resized)? onResizeUpdate, void Function(List resized)? onResizeEnd, @@ -50,7 +50,7 @@ abstract interface class FResizableController extends FChangeNotifier { /// /// [onResizeEnd] is called after a resizable region and its neighbours have been resized. /// - /// See https://forui.dev/docs/resizable for a working example. + /// See https://forui.dev/docs/layout/resizable for a working example. factory FResizableController.cascade({ void Function(List resized)? onResizeUpdate, void Function(UnmodifiableListView all)? onResizeEnd, diff --git a/forui/lib/src/widgets/resizable/resizable_region.dart b/forui/lib/src/widgets/resizable/resizable_region.dart index 5230c2895..a867cd95f 100644 --- a/forui/lib/src/widgets/resizable/resizable_region.dart +++ b/forui/lib/src/widgets/resizable/resizable_region.dart @@ -6,7 +6,7 @@ import 'package:forui/src/widgets/resizable/resizable.dart'; /// A resizable region that can be resized along the parent [FResizable]'s axis. It should always be in a [FResizable]. /// -/// See https://forui.dev/docs/resizable for working examples. +/// See https://forui.dev/docs/layout/resizable for working examples. class FResizableRegion extends StatelessWidget { /// The initial extent along the resizable axis, in logical pixels. /// diff --git a/forui/lib/src/widgets/scaffold.dart b/forui/lib/src/widgets/scaffold.dart index c0b1e7472..859758e55 100644 --- a/forui/lib/src/widgets/scaffold.dart +++ b/forui/lib/src/widgets/scaffold.dart @@ -11,7 +11,7 @@ import 'package:forui/forui.dart'; /// It is highly recommended to use a scaffold when creating a page even if a header and footer are not required. /// /// See: -/// * https://forui.dev/docs/scaffold for working examples. +/// * https://forui.dev/docs/layout/scaffold for working examples. /// * [FScaffoldStyle] for customizing a scaffold's appearance. class FScaffold extends StatelessWidget { /// The content. diff --git a/forui/lib/src/widgets/select_group/select_group.dart b/forui/lib/src/widgets/select_group/select_group.dart index d7acd3700..27a252453 100644 --- a/forui/lib/src/widgets/select_group/select_group.dart +++ b/forui/lib/src/widgets/select_group/select_group.dart @@ -13,7 +13,7 @@ import 'package:forui/src/widgets/select_group/select_group_item.dart'; /// Typically used to group multiple [FSelectGroupItem.checkbox]s or [FSelectGroupItem.radio]s. /// /// See: -/// * https://forui.dev/docs/select-group for working examples. +/// * https://forui.dev/docs/form/select-group for working examples. /// * [FSelectGroupStyle] for customizing a select group's appearance. class FSelectGroup extends FormField> { static Widget _errorBuilder(BuildContext context, String error) => Text(error); diff --git a/forui/lib/src/widgets/slider/slider.dart b/forui/lib/src/widgets/slider/slider.dart index b1d0c47e3..452cec439 100644 --- a/forui/lib/src/widgets/slider/slider.dart +++ b/forui/lib/src/widgets/slider/slider.dart @@ -13,7 +13,7 @@ import 'package:forui/src/widgets/slider/inherited_data.dart'; /// A slider is a form field and therefore can be used within a [Form] widget. /// /// See: -/// * https://forui.dev/docs/slider for working examples. +/// * https://forui.dev/docs/form/slider for working examples. /// * [FContinuousSliderController.new] for selecting a single continuous value. /// * [FContinuousSliderController.range] for selecting continuous range. /// * [FDiscreteSliderController.new] for selecting a discrete value. diff --git a/forui/lib/src/widgets/switch.dart b/forui/lib/src/widgets/switch.dart index ac9d72e5b..233b5f067 100644 --- a/forui/lib/src/widgets/switch.dart +++ b/forui/lib/src/widgets/switch.dart @@ -12,7 +12,7 @@ import 'package:forui/forui.dart'; /// Typically used to toggle the on/off state of a single setting. /// /// See: -/// * https://forui.dev/docs/switch for working examples. +/// * https://forui.dev/docs/form/switch for working examples. /// * [FSwitchStyle] for customizing a switch's appearance. class FSwitch extends StatelessWidget { /// The style. Defaults to [FThemeData.switchStyle]. diff --git a/forui/lib/src/widgets/tabs/tabs.dart b/forui/lib/src/widgets/tabs/tabs.dart index 074802fe4..1e3204653 100644 --- a/forui/lib/src/widgets/tabs/tabs.dart +++ b/forui/lib/src/widgets/tabs/tabs.dart @@ -36,7 +36,7 @@ class FTabEntry { /// Allows switching between widgets through tabs. /// /// See: -/// * https://forui.dev/docs/tabs for working examples. +/// * https://forui.dev/docs/navigation/tabs for working examples. /// * [FTabsStyle] for customizing tabs' appearance. class FTabs extends StatefulWidget { /// The tab controller. diff --git a/forui/lib/src/widgets/text_field/text_field.dart b/forui/lib/src/widgets/text_field/text_field.dart index f6df7d7e2..1b591f1ed 100644 --- a/forui/lib/src/widgets/text_field/text_field.dart +++ b/forui/lib/src/widgets/text_field/text_field.dart @@ -15,7 +15,7 @@ import 'package:forui/src/widgets/text_field/field.dart'; /// a [FormField], therefore it can be used in a [Form]. /// /// See: -/// * https://forui.dev/docs/text-field for working examples. +/// * https://forui.dev/docs/form/text-field for working examples. /// * [FTextFieldStyle] for customizing a text field's appearance. /// * [TextField] for more details about working with a text field. final class FTextField extends StatelessWidget { diff --git a/forui/lib/src/widgets/tooltip.dart b/forui/lib/src/widgets/tooltip.dart index 6ad2f8bd6..bd366b318 100644 --- a/forui/lib/src/widgets/tooltip.dart +++ b/forui/lib/src/widgets/tooltip.dart @@ -69,7 +69,7 @@ class FTooltipController extends FChangeNotifier { /// callback. /// /// See: -/// * https://forui.dev/docs/tooltip for working examples. +/// * https://forui.dev/docs/overlay/tooltip for working examples. /// * [FTooltipController] for controlling a tooltip. /// * [FTooltipStyle] for customizing a tooltip's appearance. class FTooltip extends StatefulWidget { diff --git a/forui/lib/widgets/alert.dart b/forui/lib/widgets/alert.dart index c1879c0df..8bc99672d 100644 --- a/forui/lib/widgets/alert.dart +++ b/forui/lib/widgets/alert.dart @@ -2,7 +2,7 @@ /// /// Displays a callout for user attention. /// -/// See https://forui.dev/docs/alert for working examples. +/// See https://forui.dev/docs/navigation/alert for working examples. library forui.widgets.alert; export '../src/widgets/alert.dart' hide Variant; diff --git a/forui/lib/widgets/avatar.dart b/forui/lib/widgets/avatar.dart index e3d88c462..73db6546c 100644 --- a/forui/lib/widgets/avatar.dart +++ b/forui/lib/widgets/avatar.dart @@ -2,7 +2,7 @@ /// /// An image element with a fallback for representing the user. /// -/// See https://forui.dev/docs/avatar for working examples. +/// See https://forui.dev/docs/data/avatar for working examples. library forui.widgets.avatar; export '../src/widgets/avatar/avatar.dart'; diff --git a/forui/lib/widgets/badge.dart b/forui/lib/widgets/badge.dart index 4faf71b67..9a00ce7b8 100644 --- a/forui/lib/widgets/badge.dart +++ b/forui/lib/widgets/badge.dart @@ -2,7 +2,7 @@ /// /// A badge. Badges are typically used to draw attention to specific information, such as labels and counts. /// -/// See https://forui.dev/docs/badge for working examples. +/// See https://forui.dev/docs/data/badge for working examples. library forui.widgets.badge; export '../src/widgets/badge/badge.dart' hide Variant; diff --git a/forui/lib/widgets/bottom_navigation_bar.dart b/forui/lib/widgets/bottom_navigation_bar.dart index 74503f377..5e55c3f64 100644 --- a/forui/lib/widgets/bottom_navigation_bar.dart +++ b/forui/lib/widgets/bottom_navigation_bar.dart @@ -2,7 +2,7 @@ /// /// A bottom navigation bar. /// -/// See https://forui.dev/docs/bottom-navigation-bar for working examples. +/// See https://forui.dev/docs/navigation/bottom-navigation-bar for working examples. library forui.widgets.bottom_navigation_bar; export '../src/widgets/bottom_navigation_bar/bottom_navigation_bar.dart'; diff --git a/forui/lib/widgets/button.dart b/forui/lib/widgets/button.dart index d4bd9edf0..9cd05e543 100644 --- a/forui/lib/widgets/button.dart +++ b/forui/lib/widgets/button.dart @@ -2,7 +2,7 @@ /// /// A button. /// -/// See https://forui.dev/docs/button for working examples. +/// See https://forui.dev/docs/form/button for working examples. library forui.widgets.button; export '../src/widgets/button/button.dart' hide Variant; diff --git a/forui/lib/widgets/calendar.dart b/forui/lib/widgets/calendar.dart index 3b5dd1213..76d0c8c58 100644 --- a/forui/lib/widgets/calendar.dart +++ b/forui/lib/widgets/calendar.dart @@ -2,7 +2,7 @@ /// /// A calendar. /// -/// See https://forui.dev/docs/calendar for working examples. +/// See https://forui.dev/docs/form/calendar for working examples. library forui.widgets.calendar; export '../src/widgets/calendar/calendar.dart'; diff --git a/forui/lib/widgets/card.dart b/forui/lib/widgets/card.dart index 607b5263f..3498eb406 100644 --- a/forui/lib/widgets/card.dart +++ b/forui/lib/widgets/card.dart @@ -2,7 +2,7 @@ /// /// A card. /// -/// See https://forui.dev/docs/card for working examples. +/// See https://forui.dev/docs/data/card for working examples. library forui.widgets.card; export '../src/widgets/card/card.dart'; diff --git a/forui/lib/widgets/checkbox.dart b/forui/lib/widgets/checkbox.dart index b7fc07bf4..3efab958f 100644 --- a/forui/lib/widgets/checkbox.dart +++ b/forui/lib/widgets/checkbox.dart @@ -2,7 +2,7 @@ /// /// A checkbox control that allows the user to toggle between checked and not checked. /// -/// See https://forui.dev/docs/checkbox for working examples. +/// See https://forui.dev/docs/form/checkbox for working examples. library forui.widgets.checkbox; export '../src/widgets/checkbox.dart'; diff --git a/forui/lib/widgets/dialog.dart b/forui/lib/widgets/dialog.dart index bb3df595f..2b095ec86 100644 --- a/forui/lib/widgets/dialog.dart +++ b/forui/lib/widgets/dialog.dart @@ -2,7 +2,7 @@ /// /// A modal dialog. /// -/// See https://forui.dev/docs/dialog for working examples. +/// See https://forui.dev/docs/overlay/dialog for working examples. library forui.widgets.dialog; export '../src/widgets/dialog/dialog.dart'; diff --git a/forui/lib/widgets/divider.dart b/forui/lib/widgets/divider.dart index e670ca026..f470878d4 100644 --- a/forui/lib/widgets/divider.dart +++ b/forui/lib/widgets/divider.dart @@ -2,7 +2,7 @@ /// /// A divider. /// -/// See https://forui.dev/docs/divider for working examples. +/// See https://forui.dev/docs/layout/divider for working examples. library forui.widgets.divider; export '../src/widgets/divider.dart'; diff --git a/forui/lib/widgets/header.dart b/forui/lib/widgets/header.dart index bf427e437..e06dea794 100644 --- a/forui/lib/widgets/header.dart +++ b/forui/lib/widgets/header.dart @@ -2,7 +2,7 @@ /// /// A header. /// -/// See https://forui.dev/docs/header for working examples. +/// See https://forui.dev/docs/navigation/header for working examples. library forui.widgets.header; export '../src/widgets/header/header.dart'; diff --git a/forui/lib/widgets/icon.dart b/forui/lib/widgets/icon.dart index 19a3ebe05..0b659cbf7 100644 --- a/forui/lib/widgets/icon.dart +++ b/forui/lib/widgets/icon.dart @@ -2,7 +2,7 @@ /// /// An icon that may inherit its style from its enclosing widget if supported. /// -/// See https://forui.dev/docs/icon for working examples. +/// See https://forui.dev/docs/data/icon for working examples. library forui.widgets.icon; export '../src/widgets/icon.dart'; diff --git a/forui/lib/widgets/label.dart b/forui/lib/widgets/label.dart index e077fb397..c77bcc14a 100644 --- a/forui/lib/widgets/label.dart +++ b/forui/lib/widgets/label.dart @@ -2,7 +2,7 @@ /// /// A label that describes a form field with a label, description, and error message (if any). /// -/// See https://forui.dev/docs/label for working examples. +/// See https://forui.dev/docs/form/label for working examples. library forui.widgets.label; export '../src/widgets/label.dart'; diff --git a/forui/lib/widgets/popover.dart b/forui/lib/widgets/popover.dart index a53636873..5a0dcf046 100644 --- a/forui/lib/widgets/popover.dart +++ b/forui/lib/widgets/popover.dart @@ -2,7 +2,7 @@ /// /// A popover displays rich content in a portal that is aligned to a target. /// -/// See https://forui.dev/docs/popover for working examples. +/// See https://forui.dev/docs/overlay/popover for working examples. library forui.widgets.popover; export '../src/widgets/popover.dart'; diff --git a/forui/lib/widgets/progress.dart b/forui/lib/widgets/progress.dart index 0a83dc488..353a73847 100644 --- a/forui/lib/widgets/progress.dart +++ b/forui/lib/widgets/progress.dart @@ -2,7 +2,7 @@ /// /// A progress bar. /// -/// See https://forui.dev/docs/progress for working examples. +/// See https://forui.dev/docs/navigation/progress for working examples. library forui.widgets.progress; export '../src/widgets/progress.dart'; diff --git a/forui/lib/widgets/radio.dart b/forui/lib/widgets/radio.dart index c7575ef59..00a6df974 100644 --- a/forui/lib/widgets/radio.dart +++ b/forui/lib/widgets/radio.dart @@ -5,7 +5,7 @@ /// It is recommended to use [FSelectGroup] in conjunction with [FSelectGroupItem.radio] to create a group of radio /// buttons. /// -/// See https://forui.dev/docs/radio for working examples. +/// See https://forui.dev/docs/form/radio for working examples. library forui.widgets.radio; import 'package:forui/forui.dart'; diff --git a/forui/lib/widgets/resizable.dart b/forui/lib/widgets/resizable.dart index 226d5522d..8d093add9 100644 --- a/forui/lib/widgets/resizable.dart +++ b/forui/lib/widgets/resizable.dart @@ -2,7 +2,7 @@ /// /// A resizable which children can be resized along either the horizontal or vertical main axis. /// -/// See https://forui.dev/docs/resizable for working examples. +/// See https://forui.dev/docs/layout/resizable for working examples. library forui.widgets.resizable; export '../src/widgets/resizable/resizable.dart' hide InheritedData; diff --git a/forui/lib/widgets/scaffold.dart b/forui/lib/widgets/scaffold.dart index ded28518a..c46ff9dbd 100644 --- a/forui/lib/widgets/scaffold.dart +++ b/forui/lib/widgets/scaffold.dart @@ -2,7 +2,7 @@ /// /// A scaffold. /// -/// See https://forui.dev/docs/scaffold for working examples. +/// See https://forui.dev/docs/layout/scaffold for working examples. library forui.widgets.scaffold; export '../src/widgets/scaffold.dart'; diff --git a/forui/lib/widgets/select_group.dart b/forui/lib/widgets/select_group.dart index 376709c42..3366bfbc0 100644 --- a/forui/lib/widgets/select_group.dart +++ b/forui/lib/widgets/select_group.dart @@ -2,7 +2,7 @@ /// /// A group of form fields that represent a single selection. /// -/// See https://forui.dev/docs/select-group for working examples. +/// See https://forui.dev/docs/form/select-group for working examples. library forui.widgets.select_group; export '../src/widgets/select_group/select_group.dart'; diff --git a/forui/lib/widgets/slider.dart b/forui/lib/widgets/slider.dart index aea57fe4e..d7210f9a2 100644 --- a/forui/lib/widgets/slider.dart +++ b/forui/lib/widgets/slider.dart @@ -2,7 +2,7 @@ /// /// An input where the user selects a value from within a given range. /// -/// See https://forui.dev/docs/slider for working examples. +/// See https://forui.dev/docs/form/slider for working examples. library forui.widgets.slider; export '../src/widgets/slider/slider.dart'; diff --git a/forui/lib/widgets/switch.dart b/forui/lib/widgets/switch.dart index f61372509..9c10f218c 100644 --- a/forui/lib/widgets/switch.dart +++ b/forui/lib/widgets/switch.dart @@ -2,7 +2,7 @@ /// /// A control that allows the user to toggle between checked and unchecked. /// -/// See https://forui.dev/docs/switch for working examples. +/// See https://forui.dev/docs/form/switch for working examples. library forui.widgets.switch_; // Can't use `forui.widgets.switch` because `switch` is a reserved keyword in dart. export '../src/widgets/switch.dart'; diff --git a/forui/lib/widgets/tabs.dart b/forui/lib/widgets/tabs.dart index f9c577aef..0302e8414 100644 --- a/forui/lib/widgets/tabs.dart +++ b/forui/lib/widgets/tabs.dart @@ -2,7 +2,7 @@ /// /// Allows switching between widgets through tabs. /// -/// See https://forui.dev/docs/tabs for working examples. +/// See https://forui.dev/docs/navigation/tabs for working examples. library forui.widgets.tabs; export '../src/widgets/tabs/tabs.dart'; diff --git a/forui/lib/widgets/text_field.dart b/forui/lib/widgets/text_field.dart index 55e35828b..075ab2e88 100644 --- a/forui/lib/widgets/text_field.dart +++ b/forui/lib/widgets/text_field.dart @@ -2,7 +2,7 @@ /// /// A text field. /// -/// See https://forui.dev/docs/text-field for working examples. +/// See https://forui.dev/docs/form/text-field for working examples. library forui.widgets.text_field; export '../src/widgets/text_field/text_field.dart'; diff --git a/forui/lib/widgets/tooltip.dart b/forui/lib/widgets/tooltip.dart index 8fb39f02b..affca4988 100644 --- a/forui/lib/widgets/tooltip.dart +++ b/forui/lib/widgets/tooltip.dart @@ -2,6 +2,8 @@ /// /// A tooltip displays information related to an widget when focused, hovered over on desktop, and long pressed on /// Android and iOS. +/// +/// See https://forui.dev/docs/overlay/tooltip for working examples. library forui.widgets.tooltip; export '../src/widgets/tooltip.dart';