flutter/packages
1
0
Fork 0
mirror of https://github.com/flutter/packages.git synced 2025-07-01 23:51:55 +08:00
Code Issues Packages Projects Releases Wiki Activity

added emoji support section to README (#245)

Browse Source
This commit is contained in:
Michael Jordan
2020-07-16 15:01:25 -06:00
committed by GitHub
parent 276e3931a2
commit af56836a87
1 changed files with 32 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
packages/flutter_markdown/README.md
View File

@ -24,7 +24,38 @@ but it's possible to create your own custom styling. Use the MarkdownStyle class
to pass in your own style. If you don't want to use Markdown outside of material to pass in your own style. If you don't want to use Markdown outside of material
design, use the MarkdownRaw class. design, use the MarkdownRaw class.
## Image support ## Emoji Support
Emoji glyphs can be included in the formatted text displayed by the Markdown widget by either inserting the emoji glyph directly or using the inline emoji tag syntax in the source Markdown document.
Markdown documents using UTF-8 encoding can insert emojis, symbols, and other Unicode characters directly in the source document. Emoji glyphs inserted directly in the Markdown source data are treated as text and preserved in the formatted output of the Markdown widget. For example, in the following Markdown widget constructor, a text string with a smiley face emoji is passed in as the source Markdown data.
```
Markdown(
controller: controller,
selectable: true,
data: 'Insert emoji here😀 ',
)
```
The resulting Markdown widget will contain a single line of text with the emoji preserved in the formatted text output.
The second method for including emoji glyphs is to provide the Markdown widget with a syntax extension for inline emoji tags. The Markdown package includes a syntax extension for emojis, EmojiSyntax. The default extension set used by the Markdown widget is the GitHub flavored extension set. This pre-defined extension set approximates the GitHub supported Markdown tags, providing syntax handlers for fenced code blocks, tables, auto-links, and strike-through. To include the inline emoji tag syntax while maintaining the default GitHub flavored Markdown behavior, define an extension set that combines EmojiSyntax with ExtensionSet.gitHubFlavored.
```
import 'package:markdown/markdown.dart' as md;
Markdown(
controller: controller,
selectable: true,
data: 'Insert emoji :smiley: here',
extensionSet: md.ExtensionSet(
[md.gitHubFlavored.blockSyntaxes],
[md.EmojiSyntax(), ...md.gitHubFlavored.inlineSyntaxes]),
)
```
## Image Support
The `Img` tag only supports the following image locations: The `Img` tag only supports the following image locations: