Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@yiszza
yiszza committed Feb 28, 2023
1 parent f71b95c commit 7067707
Show file tree
Hide file tree
Showing 11 changed files with 64 additions and 48 deletions.
5 changes: 3 additions & 2 deletions docs/FAB.md
View file
Expand Up @@ -27,8 +27,9 @@ There are 9 Styles of FABs: 1. Secondary, 2. Surface, 3. Tertiary, 4. SmallSe
| name | type | defalut | describes |
| ---------------- | ----------- | ------- | ------------------------------------- |
| Text | string | empty | FAB's text |
| Icon | IconKind | none | FAB's icon |
| IconSource | SkPicture | | FAB's icon |
| IconKind | IconKind | none | FAB's icon from iconkind. |
| IconSource | SkPicture | | FAB's icon from file. |
| IconData | string | empty | FAB's icon from path data. |
| IsExtended | bool | false | FAB's extended state |
| BackgroundColour | Color | style | FAB's background color. |
| ForegroundColor | Color | style | FAB's foreground color. |
Expand Down
7 changes: 4 additions & 3 deletions docs/button.md
View file
Expand Up @@ -26,9 +26,10 @@ There are 5 Styles of buttons: 1. Elevated, 2. Filled, 3. FilledTonal , 4. Outl

| name | type | defalut | describes |
| ---------------- | ----------- | ------- | ---------------------------------------- |
| Text | string | empty | button's text |
| Icon | IconKind | none | button's icon |
| IconSource | SkPicture | | button's icon |
| Text | string | empty | button's text. |
| IconKind | IconKind | none | button's icon from iconkind. |
| IconSource | SkPicture | | button's icon from file. |
| IconData | string | empty | button's icon from path data. |
| BackgroundColour | Color | style | button's background color. |
| ForegroundColor | Color | style | button's foreground color. |
| FontFamily | string | | font family of the button's text. |
Expand Down
5 changes: 3 additions & 2 deletions docs/chip.md
View file
Expand Up @@ -33,8 +33,9 @@ There are 7 styles of chips: 1. Assist, 2. AssistElevated, 3. Filter, 4. Filt
| IsChecked | bool | false | chip's selected state(only support Filter and FilterElevated style). |
| HasCloseIcon | bool | false | show or hide close-icon of the chip. |
| Text | string | empty | chip's text. |
| Icon | IconKind | none | chip's icon |
| IconSource | SkPicture | | chip's icon |
| IconKind | IconKind | none | chip's icon from iconkind. |
| IconSource | SkPicture | | chip's icon from file. |
| IconData | string | empty | chip's icon from path data. |
| IconColor | Color | style | chip's icon color |
| BackgroundColour | Color | style | chip's background color |
| ForegroundColor | Color | style | chip's foreground color |
Expand Down
5 changes: 3 additions & 2 deletions docs/context-menu.md
View file
Expand Up @@ -39,8 +39,9 @@ ContextMenu display a list of choices on a temporary surface, It can be included
| name | type | default | describes |
| ---------------- | --------- | ------- | ------------------------------------------ |
| Text | string | empty | MenuItem's text. |
| Icon | IconKind | none | MenuItem's Icon. |
| IconSource | SkPicture | | MenuItem's icon |
| IconKind | IconKind | none | MenuItem's icon from iconkind. |
| IconSource | SkPicture | | MenuItem's icon from file. |
| IconData | string | empty | MenuItem's icon from path data. |
| BackgroundColour | Color | style | MenuItem's background color. |
| ForegroundColor | Color | style | MenuItem's foreground color. |
| FontFamily | string | | font family of the MenuItem's text. |
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started.md
View file
Expand Up @@ -60,7 +60,7 @@
<ResourceDictionary Source="Resources/Styles/Colors.xaml" />
<ResourceDictionary Source="Resources/Styles/Styles.xaml" />
<mds:MaterialStyles />
<!--or use seendColor
<!--or use seedColor
<mds:MaterialStyles Dark="DarkBlue" Light="Green" />-->
</ResourceDictionary.MergedDictionaries>
</ResourceDictionary>
Expand Down
5 changes: 3 additions & 2 deletions docs/icon-button.md
View file
Expand Up @@ -25,8 +25,9 @@ There are 4 Styles of icon buttons: 1. Filled, 2. FilledTonal , 3. Outlined, 4.

| name | type | defalut | describes |
| ---------------- | ----------- | ------- | ------------------------------------- |
| Icon | IconKind | none | button's icon |
| IconSource | SkPicture | | button's icon |
| IconKind | IconKind | none | button's icon from iconkind. |
| IconSource | SkPicture | | button's icon from file. |
| IconData | string | empty | button's icon from path data. |
| BackgroundColour | Color | style | button's background color. |
| ForegroundColor | Color | style | button's foreground color. |
| Shape | Shape | style | corner radius of the button's border. |
Expand Down
3 changes: 3 additions & 0 deletions docs/icon-kind.md
View file
@@ -0,0 +1,3 @@
# IconKind

IconKind uses the material icon from Google by default, you can be browsed at https://fonts.google.com/icons.
36 changes: 19 additions & 17 deletions docs/navigation-bar.md
View file
Expand Up @@ -47,23 +47,25 @@ Navigation bars offer a persistent and convenient way to switch between primary

## NavigationBarItem Properties

| name | type | default | describes |
| -------------------- | --------- | ------- | --------------------------------------------------- |
| Content | View | | NavigationBarItem's contain content. |
| Text | string | empty | NavigationBarItem's text. |
| Icon | IconKind | none | NavigationBarItem's icon. |
| IconSource | SkPicture | | NavigationBarItem's icon. |
| ActivedIcon | IconKind | none | NavigationBarItem's icon when actived. |
| ActivedIconSource | SkPicture | | NavigationBarItem's icon when actived. |
| ActiveIndicatorColor | Color | style | NavigationBarItem's activeIndicator color. |
| IconColor | Color | style | NavigationBarItem's icon color. |
| BackgroundColour | Color | style | NavigationBarItem's background color. |
| ForegroundColor | Color | style | NavigationBarItem's foreground color. |
| FontFamily | string | | font family of the NavigationBarItem's text. |
| FontSize | float | 14 | font size of the NavigationBarItem's text. |
| FontWeight | int | 400 | font weight of the NavigationBarItem's text. |
| FontItalic | bool | false | enable font italic of the NavigationBarItem's text. |
| RippleColor | Color | style | NavigationBarItem's ripple color. |
| name | type | default | describes |
| -------------------- | --------- | ------- | ----------------------------------------------------- |
| Content | View | | NavigationBarItem's contain content. |
| Text | string | empty | NavigationBarItem's text. |
| IconKind | IconKind | none | NavigationBarItem's icon from iconkind. |
| IconSource | SkPicture | | NavigationBarItem's icon from file. |
| IconData | string | empty | NavigationBarItem's icon from path data. |
| ActivedIconKind | IconKind | none | NavigationBarItem's icon from iconkind when actived. |
| ActivedIconSource | SkPicture | | NavigationBarItem's icon from file when actived. |
| ActivedIconData | string | empty | NavigationBarItem's icon from path data when actived. |
| ActiveIndicatorColor | Color | style | NavigationBarItem's activeIndicator color. |
| IconColor | Color | style | NavigationBarItem's icon color. |
| BackgroundColour | Color | style | NavigationBarItem's background color. |
| ForegroundColor | Color | style | NavigationBarItem's foreground color. |
| FontFamily | string | | font family of the NavigationBarItem's text. |
| FontSize | float | 14 | font size of the NavigationBarItem's text. |
| FontWeight | int | 400 | font weight of the NavigationBarItem's text. |
| FontItalic | bool | false | enable font italic of the NavigationBarItem's text. |
| RippleColor | Color | style | NavigationBarItem's ripple color. |



Expand Down
29 changes: 16 additions & 13 deletions docs/navigation-drawer.md
View file
Expand Up @@ -44,19 +44,22 @@ Navigation drawers provide ergonomic access to destinations in an app.

## NavigationDrawerItem Properties

| name | type | default | describes |
| -------------------- | ------ | ----------------------- | ------------------------------------------------------ |
| Title | string | empty | NavigationDrawerItem's title. |
| Text | string | empty | NavigationDrawerItem's Text. |
| ContentType | Type | | NavigationDrawerItem's contain content type. |
| ActiveIndicatorColor | | SecondaryContainerColor | NavigationDrawerItem's activeIndicator color. |
| BackgroundColour | Color | Transparent | NavigationDrawerItem's background color. |
| ForegroundColor | Color | OnSurfaceVariantColor | NavigationDrawerItem's foreground color. |
| FontFamily | string | | font family of the NavigationDrawerItem's text. |
| FontSize | float | 14 | font size of the NavigationDrawerItem's text. |
| FontWeight | int | 500 | font weight of the NavigationDrawerItem's text. |
| FontItalic | bool | false | enable font italic of the NavigationDrawerItem's text. |
| RippleColor | Color | SurfaceTintColor | NavigationDrawerItem's ripple color. |
| name | type | default | describes |
| -------------------- | --------- | ----------------------- | ------------------------------------------------------ |
| Title | string | empty | NavigationDrawerItem's title. |
| Text | string | empty | NavigationDrawerItem's Text. |
| ContentType | Type | | NavigationDrawerItem's contain content type. |
| IconKind | IconKind | none | NavigationDrawerItem's icon from iconkind. |
| IconSource | SkPicture | | NavigationDrawerItem's icon from file. |
| IconData | string | empty | NavigationDrawerItem's icon from path data. |
| ActiveIndicatorColor | | SecondaryContainerColor | NavigationDrawerItem's activeIndicator color. |
| BackgroundColour | Color | Transparent | NavigationDrawerItem's background color. |
| ForegroundColor | Color | OnSurfaceVariantColor | NavigationDrawerItem's foreground color. |
| FontFamily | string | | font family of the NavigationDrawerItem's text. |
| FontSize | float | 14 | font size of the NavigationDrawerItem's text. |
| FontWeight | int | 500 | font weight of the NavigationDrawerItem's text. |
| FontItalic | bool | false | enable font italic of the NavigationDrawerItem's text. |
| RippleColor | Color | SurfaceTintColor | NavigationDrawerItem's ripple color. |



Expand Down
5 changes: 3 additions & 2 deletions docs/tabs.md
View file
Expand Up @@ -68,8 +68,9 @@ There are 2 Styles of : 1. Filled, 2. Scrolled.
| Content | View | | TabItem's contain content. |
| IsActived | bool | false | TabItem's selected state. |
| Text | string | empty | TabItem's Text. |
| Icon | IconKind | none | TabItem's icon. |
| IconSource | SkPicture | | TabItem's icon. |
| IconKind | IconKind | none | TabItem's icon from iconkind. |
| IconSource | SkPicture | | TabItem's icon from file. |
| IconData | string | empty | TabItem's icon from path data. |
| ActiveIndicatorColor | Color | style | TabItem's activeIndicator color. |
| BackgroundColour | Color | style | TabItem's background color. |
| ForegroundColor | Color | style | TabItem's foreground color. |
Expand Down
10 changes: 6 additions & 4 deletions docs/text-field.md
View file
Expand Up @@ -33,10 +33,12 @@ There are 2 Styles of text fields: 1. Filled, 2. Outlined.
| IsError | bool | | TextField's verified state. |
| CaretPosition | int | | TextField's caret position. |
| CaretColor | Color | style | TextField's caret and cursor color. |
| Icon | IconKind | none | TextField's icon. |
| IconSource | SkPicture | | TextField's icon. |
| TrailingIcon | IconKind | none | TextField's trailing icon. |
| TrailingIconSource | SkPicture | | TextField's trailing icon. |
| IconKind | IconKind | none | TextField's icon from iconkind. |
| IconSource | SkPicture | | TextField's icon from file. |
| IconData | string | empty | TextField's icon from path data. |
| TrailingIcon | IconKind | none | TextField's trailing icon from iconkind. |
| TrailingIconSource | SkPicture | | TextField's trailing icon from file. |
| TrailingIconData | string | empty | TextField's trailing icon from path data. |
| LabelText | string | Label text | TextField's label text. |
| LabelTextColor | Color | style | TextField's label text color. |
| SupportingText | string | Supporting text | TextField's supporting text. |
Expand Down

0 comments on commit 7067707

Please sign in to comment.