-
Notifications
You must be signed in to change notification settings - Fork 3.3k
[flutter_markdown] Ensure customize nested bullet list style. #6384
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.
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
auto-submit
merged 9 commits into
flutter:main
from
Kurogoma4D:custom-nested-ordered-list
Apr 19, 2024
Merged
Changes from 3 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
d87cd9f
Add custom bullet list demo and update home screen
Kurogoma4D c626764
Add nest level on custom bullet builder
Kurogoma4D 8bc971a
Chore update CustomBulletListDemo
Kurogoma4D 5f7493d
Bump version and update CHANGELOG
Kurogoma4D 71b2d4b
Merge branch 'flutter:main' into custom-nested-ordered-list
Kurogoma4D b7f14a5
Refactor bulletBuilder parameter in MarkdownWidget
Kurogoma4D f9b64e0
Bump version and update CHANGELOG
Kurogoma4D 1faa33a
Merge remote-tracking branch 'origin/main' into custom-nested-ordered…
Kurogoma4D a3b65e3
Merge branch 'main' into custom-nested-ordered-list
domesticmouse File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
84 changes: 84 additions & 0 deletions
84
packages/flutter_markdown/example/lib/demos/custom_bullet_list_demo.dart
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,84 @@ | ||
// Copyright 2013 The Flutter Authors. All rights reserved. | ||
// Use of this source code is governed by a BSD-style license that can be | ||
// found in the LICENSE file. | ||
|
||
// TODO(goderbauer): Restructure the examples to avoid this ignore, https://github.com/flutter/flutter/issues/110208. | ||
// ignore_for_file: avoid_implementing_value_types | ||
|
||
import 'package:flutter/material.dart'; | ||
import 'package:flutter_markdown/flutter_markdown.dart'; | ||
import '../shared/markdown_demo_widget.dart'; | ||
|
||
// ignore_for_file: public_member_api_docs | ||
|
||
const String _markdownData = ''' | ||
# Custom Ordered List Demo | ||
|
||
## Unordered List | ||
|
||
- first | ||
- second | ||
- first | ||
- first | ||
- second | ||
- first | ||
- second | ||
|
||
## Ordered List | ||
|
||
1. first | ||
2. second | ||
1. first | ||
1. first | ||
2. second | ||
1. first | ||
1. second | ||
'''; | ||
|
||
const String _notes = ''' | ||
# Custom Bullet List Demo | ||
--- | ||
|
||
## Overview | ||
|
||
This is the custom bullet list demo. This demo shows how to customize the bullet list style. | ||
This demo example is being preserved for reference purposes. | ||
'''; | ||
|
||
class CustomBulletListDemo extends StatelessWidget | ||
implements MarkdownDemoWidget { | ||
const CustomBulletListDemo({super.key}); | ||
|
||
static const String _title = 'Custom Bullet List Demo'; | ||
|
||
@override | ||
String get title => CustomBulletListDemo._title; | ||
|
||
@override | ||
String get description => 'Shows how to customize the bullet list style.'; | ||
|
||
@override | ||
Future<String> get data => Future<String>.value(_markdownData); | ||
|
||
@override | ||
Future<String> get notes => Future<String>.value(_notes); | ||
|
||
@override | ||
Widget build(BuildContext context) { | ||
return Scaffold( | ||
body: SafeArea( | ||
child: Markdown( | ||
data: _markdownData, | ||
bulletBuilder: (int index, BulletStyle style, int nestLevel) => | ||
FittedBox( | ||
fit: BoxFit.scaleDown, | ||
child: switch (style) { | ||
BulletStyle.unorderedList => const Text('・'), | ||
BulletStyle.orderedList => Text('$nestLevel-${index + 1}.'), | ||
}, | ||
), | ||
), | ||
), | ||
); | ||
} | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I haven't done a full review here, but I assume the breaking change is that we're adding a parameter to a method that package clients need to implement?
If so, it would be better to make the breaking change replace it with a parameter object, so that next time it doesn't need a breaking change.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree.
Which is better to use class or record, as a parameter object here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Adding a field to a record later would be breaking (since it changes the type), so it needs to be a class to get the benefit.