Skip to content

docs: Add AutoComplete widget documentation #162

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.

Sign up for GitHub

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

Merged
divyanshub024 merged 1 commit into from
Jan 26, 2025
+30 −1
Merged

docs: Add AutoComplete widget documentation #162

Show file tree
Hide file tree
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
1 change: 0 additions & 1 deletion packages/mirai/lib/src/parsers/mirai_auto_complete/mirai_auto_complete.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ class MiraiAutoComplete with _$MiraiAutoComplete {
required List<String> options,
Map<String, dynamic>? onSelected,
@Default(200) double optionsMaxHeight,
// optionsViewBuilder,
@Default(OptionsViewOpenDirection.down)
OptionsViewOpenDirection optionsViewOpenDirection,
String? initialValue,
Expand Down
30 changes: 30 additions & 0 deletions website/docs/widgets/auto_complete.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# AutoComplete

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

## Properties

| Property | Type | Description |
|--------------------------|----------------------------|---------------------------------------------------------------------------------------------|
| options | `List<String>` | The list of options for the autocomplete. |
| onSelected | `Map<String, dynamic>?` | The callback that is called when an option is selected. |
| optionsMaxHeight | `double` | The maximum height of the options list. Defaults to `200`. |
| optionsViewOpenDirection | `OptionsViewOpenDirection` | The direction in which the options view opens. Defaults to `OptionsViewOpenDirection.down`. |
| initialValue | `String?` | The initial value of the autocomplete field. |

## Example JSON

```json
{
"type": "autoComplete",
"options": ["Option 1", "Option 2", "Option 3"],
"onSelected": {
"type": "callback",
"name": "onOptionSelected"
},
"optionsMaxHeight": 250,
"optionsViewOpenDirection": "up",
"initialValue": "Option 1"
}
```
Loading