Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mehdizarepour/text-style-editor
Text style editor widget for flutter
https://github.com/mehdizarepour/text-style-editor
dart dart-package flutter flutter-widget fonts text text-editor text-style widget
Last synced: 25 days ago
JSON representation
Text style editor widget for flutter
- Host: GitHub
- URL: https://github.com/mehdizarepour/text-style-editor
- Owner: mehdizarepour
- License: mit
- Created: 2020-08-07T12:58:42.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-05-14T08:04:50.000Z (over 3 years ago)
- Last Synced: 2024-10-07T15:51:53.703Z (about 1 month ago)
- Topics: dart, dart-package, flutter, flutter-widget, fonts, text, text-editor, text-style, widget
- Language: Dart
- Homepage:
- Size: 806 KB
- Stars: 26
- Watchers: 2
- Forks: 8
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# TextStyleEditor
[](https://pub.dev/packages/text_style_editor)
Text style editor widget for flutter
**Show some ❤️ and star the repo to support the project**
## Features
- Edit `TextStyle`
- Change `TextAlign`
- Taggle `Caps lock`
## Screenshot
## Installation
Add `text_style_editor: ^1.0.0` to your `pubspec.yaml` dependencies. And import it:
```dart
import 'package:text_style_editor/text_style_editor.dart';
```
## How to use
Simply create a `TextStyleEditor` widget, and pass the required params:
**Params**
- fonts *(`List`)*: List of the font families that you want to use in the Editor.
+ `required`
- textStyle *(`TextStyle`)*: The initial text style that you want to edit.
+ `required`
- textAlign *(`TextAlign`)*: The initial text align that you want to change.
+ `required`
- paletteColors *(`List`)*: List of the colors that you want to use in the Editor's palette.
+ `optional`
- onTextAlignEdited *(`Function(TextStyle)`)*: Callback will be called every time `textStyle` has changed.
+ `optional`
- onTextStyleEdited *(`Function(TextAlign)`)*: Callback will be called every time `textAlign` has changed.
+ `optional`
- onCpasLockTaggle *(`Function(bool)`)*: Callback will be called every time caps lock has changed to off or on.
+ `optional`
- onToolbarActionChanged *(`Function(EditorToolbarAction)`)*: Callback will be called every time editor's tool has changed.
+ `optional`
**Example**
```dart
TextStyleEditor(
fonts: fonts,
textStyle: textStyle,
textAlign: textAlign,
paletteColors: paletteColors,
onTextAlignEdited: (align) {
setState(() {
textAlign = align;
});
},
onTextStyleEdited: (style) {
setState(() {
textStyle = textStyle.merge(style);
});
},
onCpasLockTaggle: (caps) {
// Uppercase or lowercase letters
},
)
```
**To see complete example: [examples](https://github.com/mehdizarepour/text_style_editor/blob/master/example/lib/main.dart)**
# MIT License
```
Copyright (c) 2020 Mehdi Zarepour
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```