From a7de86b926ac13e4870e39e91806ddc8650060a9 Mon Sep 17 00:00:00 2001 From: "google-labs-jules[bot]" <161369871+google-labs-jules[bot]@users.noreply.github.com> Date: Mon, 1 Dec 2025 13:40:40 +0000 Subject: [PATCH 1/2] feat: add documentation for Form, Frame, Paper, Select, Skeleton, and Switch components Added MDX documentation pages for several core components that were previously missing. Each page includes usage examples, variants, and API details. --- packages/docs/pages/core/form.mdx | 59 ++++++++++ packages/docs/pages/core/frame.mdx | 120 ++++++++++++++++++++ packages/docs/pages/core/paper.mdx | 79 +++++++++++++ packages/docs/pages/core/select.mdx | 152 ++++++++++++++++++++++++++ packages/docs/pages/core/skeleton.mdx | 73 +++++++++++++ packages/docs/pages/core/switch.mdx | 128 ++++++++++++++++++++++ 6 files changed, 611 insertions(+) create mode 100644 packages/docs/pages/core/form.mdx create mode 100644 packages/docs/pages/core/frame.mdx create mode 100644 packages/docs/pages/core/paper.mdx create mode 100644 packages/docs/pages/core/select.mdx create mode 100644 packages/docs/pages/core/skeleton.mdx create mode 100644 packages/docs/pages/core/switch.mdx diff --git a/packages/docs/pages/core/form.mdx b/packages/docs/pages/core/form.mdx new file mode 100644 index 0000000..7e8590c --- /dev/null +++ b/packages/docs/pages/core/form.mdx @@ -0,0 +1,59 @@ +import Preview from '@/helper/preview.vue' +import PreviewFrame from '@/helper/preview-frame.vue' +import CodeHighlight from '@/helper/code-highlight.vue' +import Form from '@vue-material/core/Form' +import Input from '@vue-material/core/Input' +import Button from '@vue-material/core/Button' +import Flex from '@vue-material/core/Box/Flex' + +export const meta = { + title: 'Form', + description: 'A form component that provides form values to its children.', + source: 'packages/lib/src/components/Form', + inherits: [] +} + +## Usage + + + +
+ + + + + +
+
+ + + ```vue + + + + ``` + + +
+ +## Props + +`modelValue?`: any + +- The form data object. It provides values to child components based on their `name` prop. diff --git a/packages/docs/pages/core/frame.mdx b/packages/docs/pages/core/frame.mdx new file mode 100644 index 0000000..566a37d --- /dev/null +++ b/packages/docs/pages/core/frame.mdx @@ -0,0 +1,120 @@ +import Preview from '@/helper/preview.vue' +import PreviewFrame from '@/helper/preview-frame.vue' +import CodeHighlight from '@/helper/code-highlight.vue' +import Frame from '@vue-material/core/Frame' +import Flex from '@vue-material/core/Box/Flex' + +export const meta = { + title: 'Frame', + description: 'A shaped container component.', + source: 'packages/lib/src/components/Frame', + inherits: ['core/Box'] +} + +## Usage + + + + + + Frame + + + + + + ```vue + + + + ``` + + + + +## Themes + + + + + Primary + Secondary + Tertiary + Error + + + + + ```vue + + + + ``` + + + + +## Shapes + + + + + Circle + Flower + Clover + Hexagon + + + + + ```vue + + + + ``` + + + + +## Props + +> #### Inherits `BoxProps` + +`size?`: SizesString + +- The size of the frame +- Default: `96` + +`frame?`: 'circle' | 'flower' | 'clover' | 'hexagon' | 'none' + +- The shape of the frame +- Default: `'none'` + +`theme?`: 'primary' | 'secondary' | 'tertiary' | 'error' | 'none' + +- The color theme of the frame +- Default: `'none'` diff --git a/packages/docs/pages/core/paper.mdx b/packages/docs/pages/core/paper.mdx new file mode 100644 index 0000000..25e4389 --- /dev/null +++ b/packages/docs/pages/core/paper.mdx @@ -0,0 +1,79 @@ +import Preview from '@/helper/preview.vue' +import PreviewFrame from '@/helper/preview-frame.vue' +import CodeHighlight from '@/helper/code-highlight.vue' +import Paper from '@vue-material/core/Paper' +import Flex from '@vue-material/core/Box/Flex' + +export const meta = { + title: 'Paper', + description: 'A surface that displays content and actions on a single topic.', + source: 'packages/lib/src/components/Paper', + inherits: ['core/Box'] +} + +## Usage + + + + + Neutral (Default) + + + + + ```vue + + + + ``` + + + + +## Variants + + + + + Primary + Secondary + Tertiary + Error + Neutral + Outlined + + + + + ```vue + + + + ``` + + + + +## Props + +> #### Inherits `BoxProps` + +`variant?`: 'primary' | 'secondary' | 'tertiary' | 'error' | 'neutral' | 'outlined' + +- The variant of the paper +- Default: `"neutral"` diff --git a/packages/docs/pages/core/select.mdx b/packages/docs/pages/core/select.mdx new file mode 100644 index 0000000..babb4d8 --- /dev/null +++ b/packages/docs/pages/core/select.mdx @@ -0,0 +1,152 @@ +import Preview from '@/helper/preview.vue' +import PreviewFrame from '@/helper/preview-frame.vue' +import CodeHighlight from '@/helper/code-highlight.vue' +import Select from '@vue-material/core/Select' +import Flex from '@vue-material/core/Box/Flex' + +export const meta = { + title: 'Select', + description: 'Select component allow users to choose one or multiple values from a list of options.', + source: 'packages/lib/src/components/Select', + inherits: [] +} + +## Usage + + + + + + + + ```vue + + + + ``` + + + + +## Object Values + + + +