Skip to content

Commit 8719f1c

Browse files
committed
fix readme
1 parent d8e2b76 commit 8719f1c

File tree

1 file changed

+35
-24
lines changed

1 file changed

+35
-24
lines changed

README.md

Lines changed: 35 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,33 @@
1-
# message_slot_bubblegum
1+
# message\_slot\_bubblegum
22

33
![Experimental](https://img.shields.io/badge/status-experimental-blue)
44

55
> Flutter widget to help you pop your messages
66
7-
A Flutter component leveraging Material3 to dynamically render different layouts based on message content and slot configurations. It helps developers easily display messages of varying prominence and size, including customizable badges and message grouping.
7+
A Flutter component leveraging Material3 to dynamically render different
8+
layouts based on message content and slot configurations. It helps developers
9+
easily display messages of varying prominence and size, including
10+
customizable badges and message grouping.
811

9-
![Hero image for message_slot_bubblegum](doc/message_slot_bubblegum.jpeg)
12+
![Hero image for message\_slot\_bubblegum](doc/message_slot_bubblegum.jpeg)
1013

1114
Highlights:
1215

13-
* Integrates `CopperframeMessage` and `CopperframeSlotBase` models to support dynamic layout rendering.
14-
* Offers four different size configurations (`bar`, `small`, `medium`, `large`) with adjustable message counts and layout rules.
15-
* Customizable visual prominence (`low`, `medium`, `high`) to ensure appropriate emphasis for different use cases.
16-
* Supports badge display with configurable visibility based on message availability.
17-
* Handles edge cases such as no messages gracefully, ensuring a smooth user experience.
18-
19-
16+
- Integrates `CopperframeMessage` and `CopperframeSlotBase` models to
17+
support dynamic layout rendering.
18+
- Offers four different size configurations (`bar`, `small`, `medium`,
19+
`large`) with adjustable message counts and layout rules.
20+
- Customizable visual prominence (`low`, `medium`, `high`) to ensure
21+
appropriate emphasis for different use cases.
22+
- Supports badge display with configurable visibility based on message
23+
availability.
24+
- Handles edge cases such as no messages gracefully, ensuring a smooth
25+
user experience.
2026

2127
A few examples:
2228

2329
BubblegumMessageSlot Example:
30+
2431
```dart
2532
BubblegumMessageSlot(
2633
slot: _infoSlot,
@@ -39,20 +46,24 @@ BubblegumMessageSlot(
3946

4047
## Documentation and links
4148

42-
* [Code Maintenance :wrench:](MAINTENANCE.md)
43-
* [Code Of Conduct](CODE_OF_CONDUCT.md)
44-
* [Contributing :busts_in_silhouette: :construction:](CONTRIBUTING.md)
45-
* [Architectural Decision Records :memo:](DECISIONS.md)
46-
* [Contributors :busts_in_silhouette:](https://github.com/flarebyte/message_slot_bubblegum/graphs/contributors)
47-
* [Dependencies](https://github.com/flarebyte/message_slot_bubblegum/network/dependencies)
48-
* [Glossary :book:](https://github.com/flarebyte/overview/blob/main/GLOSSARY.md)
49-
* [Software engineering principles :gem:](https://github.com/flarebyte/overview/blob/main/PRINCIPLES.md)
50-
* [Overview of Flarebyte.com ecosystem :factory:](https://github.com/flarebyte/overview)
51-
* [Dart dependencies](DEPENDENCIES.md)
52-
* [Usage](USAGE.md)
53-
* [Example](example/example.dart)
49+
- [Code Maintenance :wrench:](MAINTENANCE.md)
50+
- [Code Of Conduct](CODE_OF_CONDUCT.md)
51+
- [Contributing :busts\_in\_silhouette: :construction:](CONTRIBUTING.md)
52+
- [Architectural Decision Records :memo:](DECISIONS.md)
53+
- [Contributors
54+
:busts\_in\_silhouette:](https://github.com/flarebyte/message_slot_bubblegum/graphs/contributors)
55+
- [Dependencies](https://github.com/flarebyte/message_slot_bubblegum/network/dependencies)
56+
- [Glossary
57+
:book:](https://github.com/flarebyte/overview/blob/main/GLOSSARY.md)
58+
- [Software engineering principles
59+
:gem:](https://github.com/flarebyte/overview/blob/main/PRINCIPLES.md)
60+
- [Overview of Flarebyte.com ecosystem
61+
:factory:](https://github.com/flarebyte/overview)
62+
- [Dart dependencies](DEPENDENCIES.md)
63+
- [Usage](USAGE.md)
64+
- [Example](example/example.dart)
5465

5566
## Related
5667

57-
* [Material Design 3](https://m3.material.io/)
58-
* [Flutter Documentation](https://docs.flutter.dev/)
68+
- [Material Design 3](https://m3.material.io/)
69+
- [Flutter Documentation](https://docs.flutter.dev/)

0 commit comments

Comments
 (0)