Repository navigation
Shorten Widget Styling Guide #12273
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
ConnorLand
wants to merge
3
commits into
development
Choose a base branch
from
ctl-shorten-widget-styling-docs
base: development
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Shorten Widget Styling Guide #12273
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
117 changes: 117 additions & 0 deletions
117
...igning-mobile-user-interfaces/native-styling-element-guide/accordion-styling.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,117 @@ | ||
| --- | ||
| title: "Accordion" | ||
| url: /refguide/mobile/designing-mobile-user-interfaces/accordion/ | ||
| weight: 10 | ||
| description: "This guide describes the classes and style properties of its titled widget." | ||
| --- | ||
|
|
||
| ## Introduction | ||
|
|
||
| This document describes the classes and style properties of the Accorion widget, which you can find in the __todo___ module. | ||
|
|
||
| ### Accordion {#accordion} | ||
|
|
||
| The accordion widget displays collapsible content sections with headers. | ||
|
|
||
| ```javascript | ||
| export const com_mendix_widget_native_accordion_Accordion = { | ||
| container: { | ||
| // This has all ViewStyle properties. | ||
| }, | ||
| group: { | ||
| container: { | ||
| // This has all ViewStyle properties. | ||
| }, | ||
| header: { | ||
| container: { | ||
| // This has all ViewStyle properties. | ||
| }, | ||
| heading1: { | ||
| // This has all TextStyle properties. | ||
| }, | ||
| heading2: { | ||
| // This has all TextStyle properties. | ||
| }, | ||
| heading3: { | ||
| // This has all TextStyle properties. | ||
| }, | ||
| heading4: { | ||
| // This has all TextStyle properties. | ||
| }, | ||
| heading5: { | ||
| // This has all TextStyle properties. | ||
| }, | ||
| heading6: { | ||
| // This has all TextStyle properties. | ||
| }, | ||
| icon: { | ||
| // This has all ViewStyle properties. | ||
| size: null, // The size of the expand/collapse icon. | ||
| color: null, // The color of the expand/collapse icon. | ||
| }, | ||
| }, | ||
| content: { | ||
| // This has all ViewStyle properties. | ||
| }, | ||
| }, | ||
| }; | ||
| ``` | ||
|
|
||
| | Element | Style Properties | Description | | ||
| | --- | --- | --- | | ||
| | `container` | This has all ViewStyle properties. | Styles the wrapper container around the entire accordion. | | ||
| | `group` > `container` | This has all ViewStyle properties. | Styles the container around each accordion group. | | ||
| | `group` > `header` > `container` | This has all ViewStyle properties. | Styles the header container. | | ||
| | `group` > `header` > `heading1` | This has all TextStyle properties. | Styles the heading when level 1 is selected. | | ||
| | `group` > `header` > `heading2` | This has all TextStyle properties. | Styles the heading when level 2 is selected. | | ||
| | `group` > `header` > `heading3` | This has all TextStyle properties. | Styles the heading when level 3 is selected. | | ||
| | `group` > `header` > `heading4` | This has all TextStyle properties. | Styles the heading when level 4 is selected. | | ||
| | `group` > `header` > `heading5` | This has all TextStyle properties. | Styles the heading when level 5 is selected. | | ||
| | `group` > `header` > `heading6` | This has all TextStyle properties. | Styles the heading when level 6 is selected. | | ||
| | `group` > `header` > `icon` | This has all ViewStyle properties. | Styles the expand/collapse icon. | | ||
| | `group` > `header` > `icon` | `size` | The size of the expand/collapse icon. | | ||
| | `group` > `header` > `icon` | `color` | The color of the expand/collapse icon. | | ||
| | `group` > `content` | This has all ViewStyle properties. | Styles the collapsible content area. | | ||
|
|
||
| The default class to style all accordion widgets is named `com_mendix_widget_native_accordion_Accordion`. | ||
|
|
||
| ### Activity Indicator {#activity-indicator} | ||
|
|
||
| The activity indicator widget displays a circular loading indicator. This is how an activity indicator widget could look in an app: | ||
|
|
||
| {{< figure src="/attachments/refguide/mobile/native-mobile/native-styling-refguide/activity-indicator.png" alt="activity indicator" width="350" class="no-border" >}} | ||
|
|
||
| ```javascript | ||
| export const com_mendix_widget_native_activityindicator_ActivityIndicator = { | ||
| container: { | ||
| // This has all ViewStyle properties. | ||
| }, | ||
| indicator: { | ||
| color: 'gray', // This is the color of the indicator. | ||
| size: 'large' // Possible values for indicator are `large` and `small`. | ||
| } | ||
| }; | ||
| ``` | ||
|
|
||
| | Element | Style Properties | Description | | ||
| | --- | --- | --- | | ||
| | `container` | This has all ViewStyle properties. | | | ||
| | `indicator` | `color` | This is the color of the indicator (defaults to `gray`). | | ||
| | `indicator` | `size` | Possible values for indicator are `large` and `small` (defaults to `large`). | | ||
|
|
||
| The default class to style all activity indicators is named `com_mendix_widget_native_activityindicator_ActivityIndicator`. | ||
|
|
||
| ### Animation {#animation} | ||
|
|
||
| The animation widget allows you to animate a container. You can make the content wiggle, move, change size, and more. The widget's style properties are as follows: | ||
|
|
||
| ```javascript | ||
| export const com_mendix_widget_native_animation_Animation = { | ||
| container: { | ||
| // This has all ViewStyle properties. | ||
| }, | ||
| }; | ||
| ``` | ||
|
|
||
| | Element | Style Properties | Description | | ||
| | --- | --- | --- | |
14 changes: 14 additions & 0 deletions
14
...ng-mobile-user-interfaces/native-styling-element-guide/add-on-widget-styling.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| --- | ||
| title: "Add-On Widget Styling" | ||
| url: /refguide/mobile/designing-mobile-user-interfaces/add-on-widget-styling/ | ||
| weight: 10 | ||
| description: "This guide describes the classes and style properties of add-on widgets." | ||
| --- | ||
|
|
||
| ## Introduction | ||
|
|
||
| Add-on widgets are distributed through the [Native Mobile Resources](/appstore/modules/native-mobile-resources/) module, and are not shipped with Mendix Studio Pro. Other add-ons might also be distributed through app templates, as well as modules importing pages from other apps. | ||
|
|
||
| ## Documents in this Section | ||
|
|
||
| use the metadata required to auto-populate this section with links to this doc's childeren (the add-on widgets divided by alphabet section) | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚫 [vale] reported by reviewdog 🐶
[Mendix.HeadingTitleCase] Use title case capitalization for 'Documents in this Section'.