Skip to content

Commit 7177ecc

Browse files
actions-useractions-user
committed
Update merged docs via GitHub Action
1 parent e08aba0 commit 7177ecc

3 files changed

Lines changed: 79 additions & 59 deletions

File tree

‎README.md‎

Lines changed: 37 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -5811,27 +5811,34 @@ For more information on Flutter integration tests, see the [Flutter Testing docu
58115811
Once you have built your UI with Ensemble and used it to build your app and are ready to take it to production, follow these instructions to deploy it to any iOS or Android devices, or to submit it to the Apple App Store or Google Play Store.
58125812

58135813
### Prerequisites
5814-
* Your Ensemble App ID. From [Ensemble Studio](https://studio.ensembleui.com), go to your App's Settings screen to retrieve the App ID.
5814+
5815+
- Your Ensemble App ID. From [Ensemble Studio](https://studio.ensembleui.com), go to your App's Settings screen to retrieve the App ID.
58155816

58165817
### Download Ensemble Starter
5817-
Ensemble Starter is our packaging solution, enabling you to connect to your Ensemble UI and package it.
5818-
* Clone the Starter App `git clone https://github.com/EnsembleUI/starter my_first_app` into the folder *my_first_app*. You may change the name, but don't use camelCase (e.g. myFirstApp) or dash (-) as the separators.
5819-
* Follow the README in this repo.
5818+
5819+
Ensemble Starter is our packaging solution, enabling you to connect to your Ensemble UI and package it.
5820+
5821+
- Clone the Starter App `git clone https://github.com/EnsembleUI/starter my_first_app` into the folder _my_first_app_. You may change the name, but don't use camelCase (e.g. myFirstApp) or dash (-) as the separators.
5822+
- Follow the README in this repo.
58205823

58215824
### Requesting permissions from your end-users
5825+
58225826
If your app requires capabilities like location, camera, ..., you will need to enter a reason per capability. These reasons will be prompted to the end users, who can decide whether to grant or deny your requests.
5823-
* For iOS, edit `<my_first_app>/ios/Runner/Info.plist` and add the below permissions as the direct children of the `<dict>` tag.
5824-
* For Android, edit `<my_first_app>/android/app/src/main/AndroidManifest.xml` and add the below permissions as the direct children of the `<manifest>` tag.
5827+
5828+
- For iOS, edit `<my_first_app>/ios/Runner/Info.plist` and add the below permissions as the direct children of the `<dict>` tag.
5829+
- For Android, edit `<my_first_app>/android/app/src/main/AndroidManifest.xml` and add the below permissions as the direct children of the `<manifest>` tag.
58255830

58265831
Below are the snippet per capability to insert for iOS and Android respectively.
58275832

58285833
**Location**
5834+
58295835
```xml
58305836
<key>NSLocationWhenInUseUsageDescription</key>
58315837
<string>e.g. This app needs access to your location to ....</string>
58325838
```
58335839

58345840
**Camera**
5841+
58355842
```xml
58365843
<key>NSCameraUsageDescription</key>
58375844
<string>e.g. your reason for requesting camera access</string>
@@ -5840,7 +5847,6 @@ Below are the snippet per capability to insert for iOS and Android respectively.
58405847
<string>e.g. your reason for requesting microphone access</string>
58415848
```
58425849

5843-
58445850
---
58455851

58465852
## Configure Social Sign In for Deployment
@@ -10260,24 +10266,29 @@ The Switch Widget enables the rendering of switch toggle elements, providing use
1026010266

1026110267
## Properties
1026210268

10263-
| Property | Type | Description |
10264-
| :----------- | :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
10265-
| id | string | ID to be referenced later |
10266-
| maxWidth | integer | The max width of this Input widget (default 700). while min vlaue can be `0` and maximum can be `5000` |
10267-
| label | string | Label for your widget |
10268-
| labelHint | string | Hint text on your label |
10269-
| hintText | string | Hint text explaining your widget |
10270-
| required | boolean | Whether the field is required |
10271-
| enabled | boolean | Enables or disables the interactivity and input functionality of the widget |
10272-
| icon | object | [See properties](#icon) |
10273-
| onChange | action | Call Ensemble's built-in functions or execute code when the input changes. Note for free-form text input, this event only dispatches if the text changes AND the focus is lost (e.g. clicking on button) |
10274-
| onChangeHaptic | enum | The type of haptic to perform when switch state is changed. It should be one of heavyImpact, mediumImpact, lightImpact, selectionClick, and vibrate |
10275-
| value | string | Specifying the value of your Text Input |
10276-
| autoComplete | boolean | Enable the Input search suggestion option |
10277-
| items | array | List of values, or Objects with value/label pairs |
10278-
| styles | object | [see properties](#styles) |
10279-
| leadingText | string | Sets the text displayed before the checkbox |
10280-
| trailingText | string | Sets the text displayed after the checkbox |
10269+
| Property | Type | Description |
10270+
| :----------------- | :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
10271+
| id | string | ID to be referenced later |
10272+
| maxWidth | integer | The max width of this Input widget (default 700). while min value can be `0` and maximum can be `5000` |
10273+
| label | string | Label for your widget |
10274+
| labelHint | string | Hint text on your label |
10275+
| hintText | string | Hint text explaining your widget |
10276+
| required | boolean | Whether the field is required |
10277+
| enabled | boolean | Enables or disables the interactivity and input functionality of the widget |
10278+
| icon | object | [See properties](#icon) |
10279+
| onChange | action | Call Ensemble's built-in functions or execute code when the switch value changes |
10280+
| onChangeHaptic | enum | The type of haptic to perform when switch state is changed. It should be one of heavyImpact, mediumImpact, lightImpact, selectionClick, and vibrate |
10281+
| value | boolean | The current state of the switch. `true` for on, `false` for off |
10282+
| autoComplete | boolean | Enable the Input search suggestion option |
10283+
| items | array | List of values, or Objects with value/label pairs |
10284+
| styles | object | [see properties](#styles) |
10285+
| leadingText | string | Sets the text displayed before the switch |
10286+
| trailingText | string | Sets the text displayed after the switch |
10287+
| activeColor | color | The color of the switch track when it is in the active/on state, starting with '0xFF' for full opacity. |
10288+
| inactiveColor | color | The color of the switch track when it is in the inactive/off state, starting with '0xFF' for full opacity.|
10289+
| activeThumbColor | color | The color of the switch thumb when it is in the active/on state, starting with '0xFF' for full opacity. |
10290+
| inactiveThumbColor | color | The color of the switch thumb when it is in the inactive/off state, starting with '0xFF' for full opacity.|
10291+
| useIOSStyle | boolean | If true, renders the switch using iOS-style appearance (CupertinoSwitch). When false, uses Material style (default) |
1028110292

1028210293
### styles
1028310294

@@ -10286,7 +10297,7 @@ The Switch Widget enables the rendering of switch toggle elements, providing use
1028610297
| variant | string | Select a pre-defined look and feel for this Input widget. This property can be defined in the theme to apply to all Input widgets. [see properties](#options-for-stylesvariant) |
1028710298
| visible | boolean | Toggle a widget visibility on/off. Note that an invisible widget will not occupy UI space, unless the visibilityTransitionDuration is specified. |
1028810299
| visibilityTransitionDuration | number | Specify the duration in seconds when a widget animates between visible and not visible state. Note that setting this value will cause the widget to still occupy the UI space even when it is not visible. |
10289-
| opacity | double | Adjusts the opacity of the widget. Values range from 0 (fully transparent) to 1 (opaque). Default is `1`. |
10300+
| opacity | double | Adjusts the opacity of the widget. Values range from 0 (fully transparent) to 1 (opaque). Default is `1`. |
1029010301
| stackPositionTop | integer | The distance of the child's top edge from the top of the stack. This is applicable only for Stack's children. |
1029110302
| stackPositionBottom | integer | The distance that the child's bottom edge from the bottom of the stack. This is applicable only for Stack's children. |
1029210303
| stackPositionLeft | integer | The distance that the child's left edge from the left of the stack. This is applicable only for Stack's children. |
@@ -10306,7 +10317,6 @@ The Switch Widget enables the rendering of switch toggle elements, providing use
1030610317
| borderRadius | string or integer | The border radius of the widget.This can be specified using CSS-like notation with 1 to 4 integers. Minimum value: 0. |
1030710318
| borderColor | integer or string | Sets the border color, starting with '0xFF' for full opacity. `transparent` `black` `blue` `white` `red` `grey` `teal` `amber` `pink` `purple` `yellow` `green` `brown` `cyan` `indigo` `lime` `orange` |
1030810319
| borderWidth | integer | Thickness of the border. Minimum value should be 0. |
10309-
| expanded | boolean | If the parent is a Row or Column, this flag will stretch this widget in the appropriate direction. (e.g stretch horizontally for parent of type Row) |
1031010320

1031110321
### icon
1031210322

0 commit comments

Comments
 (0)