Skip to content

Docs: Add documentation for Mirai CircleAvatar widget #145

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 22, 2025
Merged

Docs: Add documentation for Mirai CircleAvatar widget #145

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
35 changes: 35 additions & 0 deletions website/docs/widgets/circle_avatar.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# CircleAvatar

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

## Properties

| Property | Type | Description |
|-------------------------|-------------------------|-----------------------------------------------------------------------------|
| child | `Map<String, dynamic>?` | The widget to display inside the circle avatar. |
| backgroundColor | `String?` | The background color of the circle avatar. |
| backgroundImage | `String?` | The background image of the circle avatar. |
| foregroundImage | `String?` | The foreground image of the circle avatar. |
| onBackgroundImageError | `Map<String, dynamic>?` | The error widget to display if the background image fails to load. |
| onForegroundImageError | `Map<String, dynamic>?` | The error widget to display if the foreground image fails to load. |
| foregroundColor | `String?` | The color of the circle avatar's foreground elements. |
| radius | `double?` | The radius of the circle avatar. |
| minRadius | `double?` | The minimum radius of the circle avatar. |
| maxRadius | `double?` | The maximum radius of the circle avatar. |

## Example JSON

```json
{
"type": "circleAvatar",
"backgroundColor": "#FF0000",
"foregroundColor": "#FFFFFF",
"backgroundImage": "https://raw.githubusercontent.com/BuildMirai/mirai/refs/heads/dev/assets/companies/bettrdo.jpg",
"radius": 50,
"child": {
"type": "text",
"data": "A"
}
}
```