1
1
<div align =" center " >
2
2
3
- # ` Flutter ` ` WYSIWYG ` editor tutorial
3
+ # ` Flutter ` ` WYSIWYG ` Editor Tutorial
4
4
5
- 📱 📝 How to do WYSIWYG editing in Flutter in a few easy steps.
5
+ 📱 📝 How to do WYSIWYG ("What You See Is What You Get") editing
6
+ in ` Flutter ` in a few easy steps.
6
7
7
8
![ GitHub Workflow Status] ( https://img.shields.io/github/actions/workflow/status/dwyl/flutter-wysiwyg-editor-tutorial/ci.yml?label=build&style=flat-square&branch=main )
8
9
[ ![ codecov.io] ( https://img.shields.io/codecov/c/github/dwyl/flutter-wysiwyg-editor-tutorial/master.svg?style=flat-square )] ( https://codecov.io/github/dwyl/flutter-wysiwyg-editor-tutorial?branch=master )
9
10
[ ![ HitCount] ( https://hits.dwyl.com/dwyl/flutter-wysiwyg-editor-tutorial.svg?style=flat-square&show=unique )] ( https://hits.dwyl.com/dwyl/flutter-wysiwyg-editor-tutorial )
10
11
[ ![ contributions welcome] ( https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat-square )] ( https://github.com/dwyl/flutter-wysiwyg-editor-tutorial/issues )
11
12
12
13
14
+ ![ dwyl-wysiwyg-demo-optimized] ( https://github.com/dwyl/flutter-wysiwyg-editor-tutorial/assets/194400/08c6daff-33be-4f1a-9077-012cfd52b72c )
15
+
16
+
13
17
</div >
14
18
<br />
15
19
16
- - [ ` Flutter ` ` WYSIWYG ` editor tutorial ] ( #flutter-wysiwyg-editor-tutorial )
20
+ - [ ` Flutter ` ` WYSIWYG ` Editor Tutorial ] ( #flutter-wysiwyg-editor-tutorial )
17
21
- [ Why? 🤷] ( #why- )
18
22
- [ What? 💭] ( #what- )
19
23
- [ Who? 👤] ( #who- )
20
24
- [ _ How_ ? 👩💻] ( #how- )
21
25
- [ Prerequisites? 📝] ( #prerequisites- )
22
26
- [ 0. Project setup] ( #0-project-setup )
23
- - [ \*\* Make sure your ` flutter ` is up-to-date!] ( #make-sure-your-flutter-is-up-to-date )
27
+ - [ Make sure your ` Flutter ` is up-to-date!] ( #make-sure-your-flutter-is-up-to-date )
24
28
- [ 1. Installing all the needed dependencies] ( #1-installing-all-the-needed-dependencies )
25
29
- [ 2. Setting up the responsive framework] ( #2-setting-up-the-responsive-framework )
26
30
- [ 3. Create ` HomePage ` with basic editor] ( #3-create-homepage-with-basic-editor )
39
43
40
44
# Why? 🤷
41
45
42
- On our [ ` app ` ] ( https://github.com/dwyl/app ) ,
43
- people will add their todo items.
44
- To do so, they * need* a capable editor
45
- that is easy-to-use that also supports
46
- customization
47
- (new buttons).
46
+ Our
47
+ [ ` app ` ] ( https://github.com/dwyl/app ) ,
48
+ allows ` people ` to add ` items ` of ` text `
49
+ which get _ transformed_ into several types of ` list ` .
50
+ e.g: ` Todo List ` , ` Shopping List ` , ` Exercises ` , etc.
51
+ We * need* a capable editor
52
+ that is easy-to-use
53
+ and supports customization
54
+ (new buttons)
55
+ to allow them to _ easily_
56
+ transform their ` plaintext ` into ` richtext `
57
+ e.g: headings, bold, highlights, links and images!
48
58
49
59
# What? 💭
50
60
@@ -54,8 +64,8 @@ to their heart's content
54
64
and customize it to their liking.
55
65
56
66
This repo will showcase an introduction
57
- of a ` WYSIWYG ` Rich Text editor
58
- that can be used on both mobile and web devices .
67
+ of a ` WYSIWYG ` Rich Text Editor
68
+ that can be used on both ` Mobile ` and ` Web ` .
59
69
We want this editor to be * extensible* ,
60
70
meaning that we want to add specific features
61
71
and * introduce them* to the person
@@ -68,13 +78,12 @@ This quick demo is aimed at people in the @dwyl team
68
78
or anyone who is interested in learning
69
79
more about building a ` WYSIWYG ` editor.
70
80
71
- > [ !WARNING]
72
- >
73
- > Do take note that this guide is meant
74
- > ** only for ` mobile devices ` and ` web apps ` ** .
75
- > It is ** not** tailored to Flutter desktop applications.
76
- > We'll be focusing on the web and mobile devices
77
- > because it's more important * to us*
81
+ > ** Note** : this guide is meant
82
+ > ** only for ` Mobile ` devices and ` Web ` Apps** .
83
+ > It is *** not*** tailored to ** ` Desktop ` apps** .
84
+ > We are focusing on the ` Web ` and ` Mobile ` devices
85
+ > because it's
86
+ > [ more important * to us* ] ( https://github.com/dwyl/learn-flutter#mac-focussed- )
78
87
> and because it's simpler to understand.
79
88
> Some implementation details will need to be changed
80
89
> if you want this to work on desktop applications.
@@ -91,7 +100,7 @@ more about building a `WYSIWYG` editor.
91
100
This demo assumes you have foundational knowledge of ` Flutter ` .
92
101
If this is your first time tinkering with ` Flutter ` ,
93
102
we suggest you first take a look at
94
- https://github.com/dwyl/learn-flutter .
103
+ [ dwyl/learn-flutter ] ( https://github.com/dwyl/learn-flutter )
95
104
96
105
In the linked repo, you will learn
97
106
how to install the needed dependencies
@@ -120,7 +129,7 @@ this output on the terminal.
120
129
This means everything is correctly set up!
121
130
We are ready to start implementing!
122
131
123
- ### Make sure your ` flutter ` is up-to-date!
132
+ ### Make sure your ` Flutter ` is up-to-date!
124
133
125
134
Make sure you are running the latest version of ` Flutter ` !
126
135
You can make a run-through of the versions by running:
0 commit comments