Skip to content

docs: Add documentation for Mirai TextField properties #110

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Merged
merged 1 commit into from
Jan 15, 2025
Merged

docs: Add documentation for Mirai TextField properties #110

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 51 additions & 0 deletions website/docs/widgets/text_field.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Mirai TextField

The Mirai TextField allows you to build a Flutter text field widget using JSON. To know more about the text field widget in Flutter, refer to the [official documentation](https://api.flutter.dev/flutter/material/TextField-class.html).

## Properties

| Property | Type | Description |
|----------------------|-----------------------------|-----------------------------------------------------------------------------|
| decoration | `MiraiInputDecoration?` | The decoration to show around the text field. |
| initialValue | `String` | The initial value to be set in the text field. |
| keyboardType | `MiraiTextInputType?` | The type of keyboard to use for editing the text. |
| textInputAction | `TextInputAction?` | The action button to use for the keyboard. |
| textCapitalization | `TextCapitalization` | How the text should be capitalized. |
| style | `MiraiTextStyle?` | The style to use for the text being edited. |
| textAlign | `TextAlign` | How the text should be aligned horizontally. |
| textAlignVertical | `MiraiTextAlignVertical?` | How the text should be aligned vertically. |
| textDirection | `TextDirection?` | The direction in which the text flows. |
| readOnly | `bool` | Whether the text field is read-only. |
| showCursor | `bool?` | Whether to show the cursor. |
| expands | `bool` | Whether the text field should expand to fill its parent. |
| autofocus | `bool` | Whether the text field should focus itself if nothing else is already focused. |
| obscuringCharacter | `String` | The character to use when obscuring text. |
| maxLines | `int?` | The maximum number of lines for the text to span. |
| minLines | `int?` | The minimum number of lines for the text to span. |
| maxLength | `int?` | The maximum number of characters to allow in the text field. |
| obscureText | `bool` | Whether to hide the text being edited. |
| enableSuggestions | `bool` | Whether to show input suggestions as the user types. |
| enabled | `bool?` | Whether the text field is enabled. |
| cursorWidth | `double` | The width of the cursor. |
| cursorHeight | `double?` | The height of the cursor. |
| cursorColor | `String?` | The color of the cursor. |
| hintText | `String?` | The hint text to display when the text field is empty. |
| inputFormatters | `List<MiraiInputFormatter>` | The list of input formatters to apply to the text field. |

## Example JSON

```json
{
"type": "textField",
"initialValue": "Enter text here",
"decoration": {
"hintText": "Enter your name"
},
"style": {
"color": "#000000",
"fontSize": 16.0
},
"textAlign": "center",
"obscureText": false,
"maxLength": 50
}