Browse Source

updating quick start

Anatoly Pulyaevskiy 5 years ago
parent
commit
0f55759e40
1 changed files with 15 additions and 34 deletions
  1. 15
    34
      packages/zefyr/CHANGELOG.md

+ 15
- 34
packages/zefyr/CHANGELOG.md View File

2
 
2
 
3
 This release contains breaking changes.
3
 This release contains breaking changes.
4
 
4
 
5
-* Breaking change: `ZefyrEditor.enabled` field replaced by `ZefyrEditor.mode` which can take
6
-  one of three default values:
5
+* Breaking change: `ZefyrEditor.enabled` field replaced by `ZefyrEditor.mode` which can take one of three default values:
7
     - `ZefyrMode.edit`: the same as `enabled: true`, all editing controls are available to the user
6
     - `ZefyrMode.edit`: the same as `enabled: true`, all editing controls are available to the user
8
-    - `ZefyrMode.select`: user can't modify text itself, but allowed to select it and optionally
9
-       apply formatting.
7
+    - `ZefyrMode.select`: user can't modify text itself, but allowed to select it and optionally apply formatting.
10
     - `ZefyrMode.view`: the same as `enabled: false`, read-only.
8
     - `ZefyrMode.view`: the same as `enabled: false`, read-only.
11
-* Added optional `selectionControls` field to `ZefyrEditor` and `ZefyrEditableText`. If not provided
12
-  then by default uses platform-specific implementation.
9
+* Added optional `selectionControls` field to `ZefyrEditor` and `ZefyrEditableText`. If not provided then by default uses platform-specific implementation.
13
 * Added support for "selectAll" action in selection toolbar.
10
 * Added support for "selectAll" action in selection toolbar.
14
-* Breaking change: removed `ZefyrDefaultImageDelegate` as well as dependency on
15
-  `image_picker` plugin. Users are required to provide their own implementation. If image delegate
16
-  is not provided then image toolbar button is disabled.
17
-* Breaking change: added `ZefyrImageDelegate.cameraSource` and `ZefyrImageDelegate.gallerySource`
18
-  fields. For users of `image_picker` plugin these should return `ImageSource.camera` and
19
-  `ImageSource.gallery` respectively. See documentation on implementing image support for more
20
-  details.
11
+* Breaking change: removed `ZefyrDefaultImageDelegate` as well as dependency on `image_picker` plugin. Users are required to provide their own implementation. If image delegate is not provided then image toolbar button is disabled.
12
+* Breaking change: added `ZefyrImageDelegate.cameraSource` and `ZefyrImageDelegate.gallerySource` fields. For users of `image_picker` plugin these should return `ImageSource.camera` and `ImageSource.gallery` respectively. See documentation on implementing image support for more details.
21
 
13
 
22
 ## 0.6.0
14
 ## 0.6.0
23
 
15
 
26
 ## 0.5.0
18
 ## 0.5.0
27
 
19
 
28
 * Updated to support Flutter 1.2
20
 * Updated to support Flutter 1.2
29
-* Experimental: Added non-scrollable `ZefyrView` widget which allows previewing Notus documents
30
-  inside layouts using their own scrollables like ListView.
31
-* Breaking change: renamed `EditableRichText` to `ZefyrRichText`. User code is unlikely to be
32
-  affected unless you've extended Zefyr with custom implementations of block widgets.
33
-* Breaking change: renamed `RenderEditableParagraph` to `RenderZefyrParagraph`. User code is
34
-  unlikely to be affected unless you've extended Zefyr with custom implementations of block widgets.
35
-* Added `ZefyrScope` class - replaces previously used scope objects `ZefyrEditableTextScope` and
36
-  `ZefyrEditorScope`. Unified all shared resources under one class.
37
-* Breaking change: removed `ZefyrEditor.of` and `ZefyrEditableText.of` static methods.
38
-  Use `ZefyrScope.of` instead.
21
+* Experimental: Added non-scrollable `ZefyrView` widget which allows previewing Notus documents inside layouts using their own scrollables like ListView.
22
+* Breaking change: renamed `EditableRichText` to `ZefyrRichText`. User code is unlikely to be affected unless you've extended Zefyr with custom implementations of block widgets.
23
+* Breaking change: renamed `RenderEditableParagraph` to `RenderZefyrParagraph`. User code is unlikely to be affected unless you've extended Zefyr with custom implementations of block widgets.
24
+* Added `ZefyrScope` class - replaces previously used scope objects `ZefyrEditableTextScope` and `ZefyrEditorScope`. Unified all shared resources under one class.
25
+* Breaking change: removed `ZefyrEditor.of` and `ZefyrEditableText.of` static methods. Use `ZefyrScope.of` instead.
39
 
26
 
40
 ## 0.4.0
27
 ## 0.4.0
41
 
28
 
42
-* Breaking change: upgraded `image_picker` to `^0.5.0` and `url_launcher` to `^5.0.0` which
43
-  requires migration to Android X. You must migrate your app in order to use this version.
44
-  For details on how to migrate see:
29
+* Breaking change: upgraded `image_picker` to `^0.5.0` and `url_launcher` to `^5.0.0` which requires migration to Android X. You must migrate your app in order to use this version. For details on how to migrate see:
45
   - https://flutter.io/docs/development/packages-and-plugins/androidx-compatibility
30
   - https://flutter.io/docs/development/packages-and-plugins/androidx-compatibility
46
   - https://developer.android.com/jetpack/androidx/migrate
31
   - https://developer.android.com/jetpack/androidx/migrate
47
 
32
 
52
 
37
 
53
 ## 0.3.0
38
 ## 0.3.0
54
 
39
 
55
-This version introduces new widget `ZefyrScaffold` which allows embedding Zefyr in custom
56
-layouts, like forms with multiple input fields.
40
+This version introduces new widget `ZefyrScaffold` which allows embedding Zefyr in custom layouts, like forms with multiple input fields.
57
 
41
 
58
-It is now required to always wrap `ZefyrEditor` with an instance of this new widget. See examples
59
-and readme for more details.
42
+It is now required to always wrap `ZefyrEditor` with an instance of this new widget. See examples and readme for more details.
60
 
43
 
61
 There is also new `ZefyrField` widget which integrates Zefyr with material design decorations.
44
 There is also new `ZefyrField` widget which integrates Zefyr with material design decorations.
62
 
45
 
67
 
50
 
68
 ## 0.2.0
51
 ## 0.2.0
69
 
52
 
70
-* Breaking change: `ZefyrImageDelegate.createImageProvider` replaced with
71
-  `ZefyrImageDelegate.buildImage`.
53
+* Breaking change: `ZefyrImageDelegate.createImageProvider` replaced with `ZefyrImageDelegate.buildImage`.
72
 * Fixed redundant updates on composing range for Android.
54
 * Fixed redundant updates on composing range for Android.
73
 * Added TextCapitalization.sentences
55
 * Added TextCapitalization.sentences
74
 * Added docs for embedding images.
56
 * Added docs for embedding images.
76
 ## 0.1.2
58
 ## 0.1.2
77
 
59
 
78
 * Fixed analysis warnings.
60
 * Fixed analysis warnings.
79
-* UX: User taps on padding area around the editor and in empty space inside it now look for the nearest
80
-  paragraph to move caret to.
61
+* UX: User taps on padding area around the editor and in empty space inside it now look for the nearest paragraph to move caret to.
81
 * UX: Toggle selection toolbar on double tap instead of refreshing it.
62
 * UX: Toggle selection toolbar on double tap instead of refreshing it.
82
 
63
 
83
 ## 0.1.1
64
 ## 0.1.1