Skip to content

Commit

Permalink
documentation fix
Browse files Browse the repository at this point in the history
  • Loading branch information
suragch committed Aug 24, 2023
1 parent 7296b39 commit d7a8cc6
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 15 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
## [6.0.1] - 2023.08.22

- Fix images not displaying in pub.dev documentation.

## [6.0.0] - 2023.08.22

- Fixes for breaking changes in Flutter 2.13, mostly related to the text selection API.
Expand Down
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@ MongolText('ᠨᠢᠭᠡ ᠬᠣᠶᠠᠷ ᠭᠤᠷᠪᠠ ᠳᠦᠷᠪᠡ ᠲᠠ

The library supports mobile, web, and desktop.

![](https://github.com/suragch/mongol/blob/master/example/supplemental/mongol_text.gif)
![](./example/supplemental/mongol_text.gif)

### Emoji and CJK characters

The library rotates emoji and CJK (Chinese, Japanese, and Korean) characters for proper orientation.

![](https://github.com/suragch/mongol/blob/master/example/supplemental/emoji_cjk.png)
![](./example/supplemental/emoji_cjk.png)

### Text styling

Expand Down Expand Up @@ -69,7 +69,7 @@ const textSpan = TextSpan(
);
```

![](https://github.com/suragch/mongol/blob/master/example/supplemental/mongol_rich_text.png)
![](./example/supplemental/mongol_rich_text.png)

This all assumes you've added one or more Mongolian fonts to your app assets.

Expand Down Expand Up @@ -124,15 +124,15 @@ You may also consider using [mongol_code](https://pub.dev/packages/mongol_code)

You can use `MongolTextField` to receive and edit text from the system keyboard. This widget includes most of the functionality of the standard Flutter `TextField` widget.

![](https://github.com/suragch/mongol/blob/master/example/supplemental/mongol_text_field.gif)
![](./example/supplemental/mongol_text_field.gif)

Here is it on iOS and Android interacting with a system keyboard:

![](https://github.com/suragch/mongol/blob/master/example/supplemental/mongol_text_field_large.gif)
![](./example/supplemental/mongol_text_field_large.gif)

If you want to use an outlined text field with a label, use `MongolOutlineInputBorder`:

![](https://github.com/suragch/mongol/blob/master/example/supplemental/mongol_outline_input_border.png)
![](./example/supplemental/mongol_outline_input_border.png)

```dart
MongolTextField(
Expand Down Expand Up @@ -180,7 +180,7 @@ Card(
),
```

![](https://github.com/suragch/mongol/blob/master/example/supplemental/mongol_list_tile.png)
![](./example/supplemental/mongol_list_tile.png)

## Menus

Expand All @@ -206,7 +206,7 @@ Scaffold(
);
```

![](https://github.com/suragch/mongol/blob/master/example/supplemental/mongol_popup_menu_button.gif)
![](./example/supplemental/mongol_popup_menu_button.gif)

## Buttons

Expand All @@ -220,7 +220,7 @@ There are Mongol equivalents to all of the Flutter buttons:
- `MongolElevatedButton.icon`
- `MongolIconButton`

![](https://github.com/suragch/mongol/blob/master/example/supplemental/buttons.png)
![](./example/supplemental/buttons.png)

The reason for the Mongol icon button is to provide a vertical tooltip that will appear for a longpress on mobile and for a mouse hover on desktop and web.

Expand All @@ -230,7 +230,7 @@ The reason for the Mongol icon button is to provide a vertical tooltip that will

This alert dialog works mostly the same as the Flutter `AlertDialog`.

![](https://github.com/suragch/mongol/blob/master/example/supplemental/mongol_alert_dialog.png)
![](./example/supplemental/mongol_alert_dialog.png)

### TODO

Expand Down
2 changes: 1 addition & 1 deletion example/pubspec.lock
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ packages:
path: ".."
relative: true
source: path
version: "6.0.0"
version: "6.0.1"
path:
dependency: transitive
description:
Expand Down
10 changes: 6 additions & 4 deletions pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
name: mongol
description: Flutter widget package for displaying and editing vertical Mongolian text.
# When updating version, also update CHANGELOG.md and example/lib/main.dart
version: 6.0.0
version: 6.0.1
homepage: https://github.com/suragch/mongol
topics:
- text

environment:
sdk: ">=3.0.0 <4.0.0"
Expand All @@ -24,7 +26,7 @@ dev_dependencies:
meta: any

screenshots:
- description: 'MongolText widget'
path: example/supplemental/mongol_text.gif
- description: 'MongolText with styling'
path: example/supplemental/mongol_rich_text.png
path: example/supplemental/mongol_rich_text.png
- description: 'MongolText widget'
path: example/supplemental/mongol_text.gif

0 comments on commit d7a8cc6

Please sign in to comment.