Feat: custom leading builder

[CatHood0]

Description

A new property has been added that will allow us to configure the leading of the elements in a list without any limitations.

Example of a custom bullet list:

This code:

 customLeadingBlockBuilder: (node, config) {
     if (config.attribute == Attribute.ul) {
            final indent = (config.attrs[Attribute.indent.key]?.value as int?) ?? 0;
             return Container(
                  alignment: AlignmentDirectional.topEnd,
                  padding: EdgeInsetsDirectional.only(end: config.padding ?? 0),
                  child: Text(
                       indent == 0
                           ? '😃'
                           : indent == 1
                                ? '👽'
                                : indent == 2
                                     ? '♥︎'
                                     : indent == 3
                                         ? '🫸'
                                         : indent == 4
                                             ? '🌏'
                                             : '🤕',
                            style: TextStyle(fontSize: 13),
               ),
          );
     }
     return null;
},

Will have this effect on the view:

Related Issues

• Fix unordered list style #2138
• Fix Background Color for Bullet Points #2149
• Fix Ability to add custom icons for lists #1611
• Fix Make QuillEditor*Point more customizable #2131

Not related issues

• Fix Numbered list wrong numeration after increase + decrease indent #1974

These issues are not related but was fixed while creating the feature.

• ✨ New feature: Adds new functionality without breaking existing features.
• 🛠️ Bug fix: Resolves an issue without altering current behavior.
• 🧹 Code refactor: Code restructuring that does not affect behavior.
• ❌ Breaking change: Alters existing functionality and requires updates.
• 🧪 Tests: Adds new tests or modifies existing tests.
• 📝 Documentation: Updates or additions to documentation.
• 🗑️ Chore: Routine tasks, or maintenance.
• ✅ Build configuration change: Changes to build or deploy processes.

Suggestions

We should stop creating such hardcoded code as it is really getting complicated trying to create default blocks to give users the opportunity to create their own independent components.

[singerdmx]

Is the node inline or block level?

[singerdmx]

OK, I got the idea.
Looking forward to see how it turns out.

[CatHood0]

Is the node inline or block level?

I trying to create builders for both types (i'm first trying for inline type, and if it works, then i will make the same for block type). I pass the TextLine as an argument of TextLineNodeBuilder to let to users wrap it, but, it cannot be wrapped since EditableTextLine expect another type of widget.

[CatHood0]

@singerdmx Do you got any idea on how to use TextLine wrapped in another type of widget? I saw that RenderContentProxyBox has methods that are used specifically for RenderEditableTextLine. If not, I'll have to just limit the Feature to being a Custom builder for Leading Lists and Code Blocks.

[CatHood0]

@EchoEllet how can i get the analizer ignore the deprecated controller param in editor_onfigurations file?

[EchoEllet]

@EchoEllet how can i get the analizer ignore the deprecated controller param in editor_onfigurations file?

Add a comment before the statement:

// ignore: deprecated_member_use_from_same_package

If this isn’t quite what you meant, I might need a few more details. I’m currently tied up with something else and haven’t had a chance to review this PR yet.

[CatHood0]

@EchoEllet thank you. There's no problem, when you have time just take a look.

[CatHood0]

I'll give up for now because the code is very dependent on certain types that don't allow me to quickly figure out how to correctly implement NodeBuilders. I'll try to implement them later, since I don't have much time for now and it's better to leave this PR as a feature so that the list leaders can be modified without any complications.

[singerdmx]

Yeah we can leave it and maybe someone else may be able to help

[singerdmx]

This is a big change and it is not so easy

[vishna]

@CatHood0 tried this PR to achieve the bullet list I mentioned in other ticket, works much nicer already 🎉 good work 🙇

My remarks:

• the base width of the leading container is not customizable but calculated based on EditableTextBlock._numberPointWidth or just font size
• LeadingConfigurations.width - relying on this to make the positioning look acceptable - it's a nullable, can it ever be null though? 🤔

      width: isOrdered || isCodeBlock
          ? _numberPointWidth(fontSize, count)
          : isUnordered
              ? fontSize * 2
              : null, // can this happen ?

It would be nice to have a custom builder for the width (and then for the deeper levels' indentation width - I didn't figure out yet which bit is adding this )

[CatHood0]

the base width of the leading container is not customizable but calculated based on EditableTextBlock._numberPointWidth or just font size

1. It is calculated by this way because it allows work with the default implementation.

LeadingConfigurations.width - relying on this to make the positioning look acceptable - it's a nullable, can it ever be null though? 🤔

2. Yes, it can be null if the list is of type Checkbox.

It would be nice to have a custom builder for the width (and then for the deeper levels' indentation width - I didn't figure out yet which bit is adding this )

Actually, the width of the TextBlock is not that easy to implement. By now width you is applied to the leading. You can always use the width in your own widgets or not use it, since they are customizable.

[vishna]

Can't you just use the width that you want?

And the width of the Leading just affects to the leading and not the entire block.

That's the point, the bounding box for whatever container I build with customLeadingBlockBuilder seems to be predetermined and will be LeadingConfigurations.width (or more for upper level). I'll try to hack something tomorrow as I want to be able to customize the space available for the customLeadingBlockBuilder

[vishna]

👋 @CatHood0

made a PR to your PR here: CatHood0#1 I hope this explains my points better 😅 Also it seems to work just fine, other test pass and I'm able to have this aspect of the library now fully customized 🎉

[singerdmx]

@CatHood0 is this ready for merging?

[vishna]

@singerdmx @CatHood0 I'd be grateful to have my changes also in 🙇

[CatHood0]

@singerdmx this can be merged now-

[singerdmx]

@CatHood0 it would be nice if there are some updates to README about this