Skip to content

docs: Add mirai text button documentation #132

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 2 commits into from
Jan 22, 2025
Merged

docs: Add mirai text button documentation #132

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dea02d5
reactor: Format docs
divyanshub024 Jan 22, 2025
cc6b13a
docs: Add mirai text button documentation
divyanshub024 Jan 22, 2025
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
12 changes: 6 additions & 6 deletions website/docs/widgets/align.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ To know more about the align widget in Flutter, refer to the [official documenta

## Properties

| Property | Type | Description |
| --- |-------------------|---------------------------------------------------|
| alignment | `MiraiAlignment` | How to align the child. |
| widthFactor | `double` | If non-null, sets its width to the child's width multiplied by this factor. |
| heightFactor | `double` | If non-null, sets its height to the child's height multiplied by this factor. |
| child | `Map<String,dynamic>` | The widget below this widget in the tree. |
| Property | Type | Description |
|--------------|-----------------------|-------------------------------------------------------------------------------|
| alignment | `MiraiAlignment` | How to align the child. |
| widthFactor | `double` | If non-null, sets its width to the child's width multiplied by this factor. |
| heightFactor | `double` | If non-null, sets its height to the child's height multiplied by this factor. |
| child | `Map<String,dynamic>` | The widget below this widget in the tree. |

## Example

Expand Down
4 changes: 2 additions & 2 deletions website/docs/widgets/aspect_ratio.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# AspectRatio
# Aspect Ratio

Mirai aspectRatio allows you to build the Flutter AspectRatio widget using JSON.
To know more about the aspectRatio widget in Flutter, refer to the [official documentation](https://api.flutter.dev/flutter/widgets/AspectRatio-class.html).
Expand All @@ -8,7 +8,7 @@ To know more about the aspectRatio widget in Flutter, refer to the [official doc
## Properties

| Property | Type | Description |
| ------------- | ----------------------- | ------------------------------------------------------------------------------------------------ |
|---------------|-------------------------|--------------------------------------------------------------------------------------------------|
| `aspectRatio` | `double` | The desired width-to-height ratio for the child widget. Defaults to `1` (a square aspect ratio). |
| `child` | `Map<String, dynamic>?` | The child widget that should adhere to the specified aspect ratio, represented as a JSON object. |

Expand Down
22 changes: 11 additions & 11 deletions website/docs/widgets/circular_progress_indicator.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
# CircularProgressIndicator
# Circular Progress Indicator

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

## Properties

| Property | Type | Description |
| --- |-------------------|---------------------------------------------------|
| value | `double` | The progress of this progress indicator. |
| backgroundColor | `String` | The hex color of the track being filled by the progress indicator. |
| color | `String` | The hex color of the progress indicator. |
| strokeWidth | `double` | The width of the progress indicator. |
| strokeAlign | `double` | The relative position of the stroke on progress indicator. |
| semanticsLabel | `String` | Provides a textual description of the widget. |
| semanticsValue | `String` | Provides a textual description of the widget. |
| strokeCap | `StrokeCap` | The progress indicator's line ending. |
| Property | Type | Description |
|-----------------|-------------|--------------------------------------------------------------------|
| value | `double` | The progress of this progress indicator. |
| backgroundColor | `String` | The hex color of the track being filled by the progress indicator. |
| color | `String` | The hex color of the progress indicator. |
| strokeWidth | `double` | The width of the progress indicator. |
| strokeAlign | `double` | The relative position of the stroke on progress indicator. |
| semanticsLabel | `String` | Provides a textual description of the widget. |
| semanticsValue | `String` | Provides a textual description of the widget. |
| strokeCap | `StrokeCap` | The progress indicator's line ending. |


## Example JSON
Expand Down
26 changes: 13 additions & 13 deletions website/docs/widgets/container.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,19 @@ To know more about the container widget in Flutter, refer to the [official docum

## Properties

| Property | Type | Description |
| --- |-------------------|---------------------------------------------------|
| alignment | `MiraiAlignment` | The alignment of the child within the container. |
| padding | `MiraiEdgeInsets` | The padding to apply around the child. |
| decoration | `MiraiBoxDecoration` | The decoration to paint behind the child. |
| foregroundDecoration | `MiraiBoxDecoration` | The decoration to paint in front of the child. |
| color | `String` | The hex color to paint behind the child. |
| width | `double` | The width of the container. |
| height | `double` | The height of the container. |
| constraints | `MiraiBoxConstraints` | Additional constraints to apply to the container. |
| margin | `MiraiEdgeInsets` | The margin to apply around the container. |
| child | `Map<String, dynamic>` | The child widget of the container. |
| clipBehavior | `Clip` | The clip behavior of the container. |
| Property | Type | Description |
|----------------------|------------------------|---------------------------------------------------|
| alignment | `MiraiAlignment` | The alignment of the child within the container. |
| padding | `MiraiEdgeInsets` | The padding to apply around the child. |
| decoration | `MiraiBoxDecoration` | The decoration to paint behind the child. |
| foregroundDecoration | `MiraiBoxDecoration` | The decoration to paint in front of the child. |
| color | `String` | The hex color to paint behind the child. |
| width | `double` | The width of the container. |
| height | `double` | The height of the container. |
| constraints | `MiraiBoxConstraints` | Additional constraints to apply to the container. |
| margin | `MiraiEdgeInsets` | The margin to apply around the container. |
| child | `Map<String, dynamic>` | The child widget of the container. |
| clipBehavior | `Clip` | The clip behavior of the container. |


## Example JSON
Expand Down
4 changes: 2 additions & 2 deletions website/docs/widgets/fitted_box.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# FittedBox
# Fitted Box

Mirai FittedBox allows you to build the Flutter FittedBox widget using JSON.
To know more about the FittedBox widget in Flutter, refer to the [official documentation](https://api.flutter.dev/flutter/widgets/FittedBox-class.html).
Expand All @@ -8,7 +8,7 @@ To know more about the FittedBox widget in Flutter, refer to the [official docum
## Properties

| Property | Type | Description |
| -------------- | --------------------------- | ------------------------------------------------------------------------------------ |
|----------------|-----------------------------|--------------------------------------------------------------------------------------|
| `fit` | `BoxFit` | Defines how the child should be fitted within the box. Defaults to `BoxFit.contain`. |
| `alignment` | `MiraiAlignmentDirectional` | Aligns the child within the box. Defaults to `MiraiAlignmentDirectional.center`. |
| `clipBehavior` | `Clip` | Specifies whether and how the content should be clipped. Defaults to `Clip.none`. |
Expand Down
4 changes: 2 additions & 2 deletions website/docs/widgets/image.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ To learn more about the equivalent Flutter widgets and their properties, refer t
## Properties

| Property | Type | Description |
| ----------- | ---------------- | --------------------------------------------------------------------------------------------------------- |
|-------------|------------------|-----------------------------------------------------------------------------------------------------------|
| `src` | `String` | The source of the image. For example, a URL for network images, file path for file images, or asset path. |
| `alignment` | `MiraiAlignment` | The alignment of the image within its container. Defaults to `MiraiAlignment.center`. |
| `imageType` | `MiraiImageType` | The type of the image source: `file`, `network`, or `asset`. Defaults to `MiraiImageType.network`. |
Expand All @@ -19,7 +19,7 @@ To learn more about the equivalent Flutter widgets and their properties, refer t
## Enum: MiraiImageType

| Value | Description |
| --------- | ------------------------------------------- |
|-----------|---------------------------------------------|
| `file` | Load the image from a local file. |
| `network` | Load the image from a network URL. |
| `asset` | Load the image from Flutter's asset bundle. |
Expand Down
4 changes: 2 additions & 2 deletions website/docs/widgets/limited_box.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# LimitedBox
# Limited Box

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

## Properties

| Property | Type | Description |
| ----------- | ----------------------- | ---------------------------------------------------------------------------------------------------- |
|-------------|-------------------------|------------------------------------------------------------------------------------------------------|
| `maxHeight` | `double` | The maximum height for the child if the parent's height is unbounded. Defaults to `double.infinity`. |
| `maxWidth` | `double` | The maximum width for the child if the parent's width is unbounded. Defaults to `double.infinity`. |
| `child` | `Map<String, dynamic>?` | The child widget represented as a JSON object. |
Expand Down
20 changes: 10 additions & 10 deletions website/docs/widgets/linear_progress_indicator.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# LinearProgressIndicator
# Linear Progress Indicator

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

## Properties

| Property | Type | Description |
| --- |-------------------|---------------------------------------------------|
| value | `double` | The progress of this progress indicator. |
| backgroundColor | `String` | The hex color of the track being filled by the progress indicator. |
| color | `String` | The hex color of the progress indicator. |
| minHeight | `double` | The height of the progress indicator. |
| semanticsLabel | `String` | Provides a textual description of the widget. |
| semanticsValue | `String` | Provides a textual description of the widget. |
| borderRadius | `MiraiBorderRadius` | The border radius for progress indicator. |
| Property | Type | Description |
|-----------------|---------------------|--------------------------------------------------------------------|
| value | `double` | The progress of this progress indicator. |
| backgroundColor | `String` | The hex color of the track being filled by the progress indicator. |
| color | `String` | The hex color of the progress indicator. |
| minHeight | `double` | The height of the progress indicator. |
| semanticsLabel | `String` | Provides a textual description of the widget. |
| semanticsValue | `String` | Provides a textual description of the widget. |
| borderRadius | `MiraiBorderRadius` | The border radius for progress indicator. |


## Example JSON
Expand Down
54 changes: 27 additions & 27 deletions website/docs/widgets/list_tile.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,36 +1,36 @@
# ListTile
# List Tile

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

## Properties

| Property | Type | Description |
| --- |-------------------|---------------------------------------------------|
| onTap | `Map<String,dynamic>` | Called when the user taps this list tile. |
| onLongPress | `Map<String,dynamic>` | Called when the user long-presses on this list tile. |
| leading | `Map<String,dynamic>` | A widget to display before the title. |
| title | `Map<String,dynamic>` | The primary content of the list tile. |
| subtitle | `Map<String,dynamic>` | Additional content displayed below the title. |
| trailing | `Map<String,dynamic>` | A widget to display after the title. |
| isThreeLine | `bool` | Whether this list tile is intended to display three lines of text. |
| dense | `bool` | Whether this list tile is part of a vertically dense list. |
| style | `ListTileStyle` | Defines the font used for the title. |
| selectedColor | `String` | Defines the color used for icons and text when the list tile is selected. |
| iconColor | `String` | Defines the default color for leading and trailing icons. |
| textColor | `String` | Defines the text color for the title, subtitle, leading, and trailing. |
| contentPadding | `MiraiEdgeInsets` | The tile's internal padding. |
| enabled | `bool` | Whether this list tile is interactive. |
| selected | `bool` | If this tile is also enabled then icons and text are rendered with the same color. |
| focusColor | `String` | The color for the tile's Material when it has the input focus. |
| hoverColor | `String` | The color for the tile's Material when a pointer is hovering over it. |
| autoFocus | `String` | True if this widget will be selected as the initial focus when no other node in its scope is currently focused. |
| tileColor | `String` | Defines the background color of ListTile when selected is false. |
| selectedTileColor | `String` | Defines the background color of ListTile when selected is true. |
| enableFeedback | `bool` | Whether detected gestures should provide acoustic and/or haptic feedback. |
| horizontalTitleGap | `double` | The horizontal gap between the titles and the leading/trailing widgets. |
| minVerticalPadding | `double` | The minimum padding on the top and bottom of the title and subtitle widgets. |
| minLeadingWidth | `double` | The minimum width allocated for the ListTile.leading widget. |
| Property | Type | Description |
|--------------------|-----------------------|-----------------------------------------------------------------------------------------------------------------|
| onTap | `Map<String,dynamic>` | Called when the user taps this list tile. |
| onLongPress | `Map<String,dynamic>` | Called when the user long-presses on this list tile. |
| leading | `Map<String,dynamic>` | A widget to display before the title. |
| title | `Map<String,dynamic>` | The primary content of the list tile. |
| subtitle | `Map<String,dynamic>` | Additional content displayed below the title. |
| trailing | `Map<String,dynamic>` | A widget to display after the title. |
| isThreeLine | `bool` | Whether this list tile is intended to display three lines of text. |
| dense | `bool` | Whether this list tile is part of a vertically dense list. |
| style | `ListTileStyle` | Defines the font used for the title. |
| selectedColor | `String` | Defines the color used for icons and text when the list tile is selected. |
| iconColor | `String` | Defines the default color for leading and trailing icons. |
| textColor | `String` | Defines the text color for the title, subtitle, leading, and trailing. |
| contentPadding | `MiraiEdgeInsets` | The tile's internal padding. |
| enabled | `bool` | Whether this list tile is interactive. |
| selected | `bool` | If this tile is also enabled then icons and text are rendered with the same color. |
| focusColor | `String` | The color for the tile's Material when it has the input focus. |
| hoverColor | `String` | The color for the tile's Material when a pointer is hovering over it. |
| autoFocus | `String` | True if this widget will be selected as the initial focus when no other node in its scope is currently focused. |
| tileColor | `String` | Defines the background color of ListTile when selected is false. |
| selectedTileColor | `String` | Defines the background color of ListTile when selected is true. |
| enableFeedback | `bool` | Whether detected gestures should provide acoustic and/or haptic feedback. |
| horizontalTitleGap | `double` | The horizontal gap between the titles and the leading/trailing widgets. |
| minVerticalPadding | `double` | The minimum padding on the top and bottom of the title and subtitle widgets. |
| minLeadingWidth | `double` | The minimum width allocated for the ListTile.leading widget. |

## Example JSON

Expand Down
Loading