Skip to content

folaoluwafemi/rich_text_editor_controller

Repository files navigation

A very lightweight package that allows rich text editing as well as providing a simple and intuitive API for data serialization

A Flutter package that lets you edit text in flutter text fields very easily, by simply just providing it a RichTextEditorController and RichTextField ( just TextField that supports changing alignment). note that you can use the controller on a normal TextField but you will not be able to change the alignment of the text.

Features

  • Data serialization (you can store and fetch your styled text in json format)
  • add bullet points
  • change text alignment
  • change text color
  • change text size (TBD)
  • change font style
  • change font family (TBD)
  • change font weight
  • change font features (TBD currently supports changing 1)
  • change text decoration
Screen.Recording.2023-04-08.at.20.41.24.mov

Getting started

add this to your pubspec.yaml file

dependencies:
  flutter:
    sdk: flutter
  rich_text_editor_flutter: 0.0.5

or using pub

pub add rich_text_editor_flutter

Usage

import 'package:flutter/material.dart';
import 'package:flutter/rich_text_editor_controller/rich_text_editor_controller.dart';

...

class _HomePageState extends State<HomePage> {

  final RichTextEditorController controller = RichTextEditorController();

  Widget build(BuildContext context) {
    return Scaffold(
      body: Center(
        child: Column(
          children: [
            RichTextField(
              controller: controller,
              maxLines: 10, //use or apply style like in normal text fields
              minLines: 1,
            ),
          ],
        ),
      ),
    );
  }

}

Or use like normal controller

 ...
//or use normal TextField but without alignment support
TextField(
  controller: controller,
  maxLines: 10,
  minLines: 1,
),

...

Don't forget to dispose your controller

  @override
void dispose() {
  controller.dispose();
  super.dispose();
}

For more elaborate example, see here

Additional information

To create issues, prs or otherwise contribute in anyway see contribution guide. See our roadmap here

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages