Disable code line number in code block by default (#1471)

* Disable code line number in code block by default

* Fix analysis issues

* Change blocks to element

* ...

CHANGELOG.md

@@ -1,3 +1,6 @@
+## [7.10.2]
+- Removing line numbers from code block by default, you still can enable this thanks to the new configurations in the `QuillEditor` you will find a `elementOptions` property, in it you will find the code which mean code block options. just pass true to `enableLineNumbers`
+
 ## [7.10.1]
 - Fixes and use the new parameters
 - You don't need to use MaterialApp anymore to use most of the toolbar buttons childBuilder anymore

lib/src/models/config/editor/configurations.dart

@@ -1,4 +1,3 @@
-// ignore_for_file: public_member_api_docs, sort_constructors_first
 import 'package:equatable/equatable.dart';
 import 'package:flutter/foundation.dart' show Brightness, Uint8List, immutable;
 import 'package:flutter/material.dart'
@@ -12,6 +11,9 @@ import '../../../widgets/embeds.dart';
 import '../../../widgets/link.dart';
 import '../../../widgets/raw_editor/raw_editor.dart';
 import '../../themes/quill_dialog_theme.dart';
+import 'element_options.dart';
+
+export 'element_options.dart';
 
 /// The configurations for the quill editor widget of flutter quill
 @immutable
@@ -62,6 +64,7 @@ class QuillEditorConfigurations extends Equatable {
     this.contextMenuBuilder,
     this.editorKey,
     this.requestKeyboardFocusOnCheckListChanged = false,
+    this.elementOptions = const QuillEditorElementOptions(),
   });
 
   /// The text placeholder in the quill editor
@@ -289,6 +292,9 @@ class QuillEditorConfigurations extends Equatable {
   /// should we request keyboard focus??
   final bool requestKeyboardFocusOnCheckListChanged;
 
+  /// This is not complete yet and might changed
+  final QuillEditorElementOptions elementOptions;
+
   @override
   List<Object?> get props => [
         placeholder,
@@ -298,6 +304,7 @@ class QuillEditorConfigurations extends Equatable {
   // We might use code generator like freezed but sometimes it can be limitied
   // instead whatever there is a change to the parameters in this class please
   // regenerate this function using extension in vs code or plugin in intellij
+
   QuillEditorConfigurations copyWith({
     String? placeholder,
     bool? readOnly,
@@ -336,6 +343,8 @@ class QuillEditorConfigurations extends Equatable {
     ContentInsertionConfiguration? contentInsertionConfiguration,
     GlobalKey<EditorState>? editorKey,
     TextSelectionThemeData? textSelectionThemeData,
+    bool? requestKeyboardFocusOnCheckListChanged,
+    QuillEditorElementOptions? elementOptions,
   }) {
     return QuillEditorConfigurations(
       placeholder: placeholder ?? this.placeholder,
@@ -384,6 +393,10 @@ class QuillEditorConfigurations extends Equatable {
       editorKey: editorKey ?? this.editorKey,
       textSelectionThemeData:
           textSelectionThemeData ?? this.textSelectionThemeData,
+      requestKeyboardFocusOnCheckListChanged:
+          requestKeyboardFocusOnCheckListChanged ??
+              this.requestKeyboardFocusOnCheckListChanged,
+      elementOptions: elementOptions ?? this.elementOptions,
     );
   }
 }

lib/src/models/config/editor/element_options.dart

@@ -0,0 +1,19 @@
+import 'package:equatable/equatable.dart';
+import 'package:flutter/foundation.dart' show immutable;
+
+import 'elements/code_block.dart';
+
+export 'elements/code_block.dart';
+
+@immutable
+class QuillEditorElementOptions extends Equatable {
+  const QuillEditorElementOptions({
+    this.code = const QuillEditorCodeBlockElementOptions(),
+  });
+
+  final QuillEditorCodeBlockElementOptions code;
+  @override
+  List<Object?> get props => [
+        code,
+      ];
+}

lib/src/models/config/editor/elements/code_block.dart

@@ -0,0 +1,18 @@
+import 'package:equatable/equatable.dart';
+import 'package:flutter/foundation.dart' show immutable;
+
+@immutable
+class QuillEditorCodeBlockElementOptions extends Equatable {
+  const QuillEditorCodeBlockElementOptions({
+    this.enableLineNumbers = false,
+  });
+
+  /// If you want line numbers in the code block, please pass true
+  /// by default it's false as it's not really needed in most cases
+  final bool enableLineNumbers;
+
+  @override
+  List<Object?> get props => [
+        enableLineNumbers,
+      ];
+}

lib/src/utils/extensions/build_context.dart

@@ -2,6 +2,9 @@ import 'package:flutter/widgets.dart' show BuildContext;
 
 import '../../../flutter_quill.dart';
 
+// TODO: The documentation of this file needs to
+//be updated as it's quite oudated.
+
 /// Public shared extension
 extension BuildContextExt on BuildContext {
   /// return [QuillProvider] as not null
@@ -67,7 +70,8 @@ extension BuildContextExt on BuildContext {
   }
 
   /// return [QuillEditorConfigurations] as not null . Since the quill
-  /// editor configurations is in the [QuillProvider] then we need to get the
+  /// editor configurations is in the [QuillEditorProvider]
+  ///  then we need to get the
   /// provider widget first and then we will return editor configurations
   /// throw exception if [QuillProvider] is not in the widget tree
   QuillEditorConfigurations get requireQuillEditorConfigurations {
@@ -75,7 +79,8 @@ extension BuildContextExt on BuildContext {
   }
 
   /// return nullable [QuillEditorConfigurations]. Since the quill
-  /// editor configurations is in the [QuillProvider] then we need to get the
+  /// editor configurations is in the [QuillEditorProvider]
+  ///  then we need to get the
   /// provider widget first and then we will return editor configurations
   /// don't throw exception if [QuillProvider] is not in the widget tree
   QuillEditorConfigurations? get quillEditorConfigurations {
@@ -83,7 +88,8 @@ extension BuildContextExt on BuildContext {
   }
 
   /// return [QuillToolbarConfigurations] as not null . Since the quill
-  /// toolbar configurations is in the [QuillProvider] then we need to get the
+  /// toolbar configurations is in the [QuillToolbarProvider]
+  /// then we need to get the
   /// provider widget first and then we will return toolbar configurations
   /// throw exception if [QuillProvider] is not in the widget tree
   QuillToolbarConfigurations get requireQuillToolbarConfigurations {
@@ -91,7 +97,8 @@ extension BuildContextExt on BuildContext {
   }
 
   /// return nullable [QuillToolbarConfigurations]. Since the quill
-  /// toolbar configurations is in the [QuillProvider] then we need to get the
+  /// toolbar configurations is in the [QuillToolbarProvider]
+  ///  then we need to get the
   /// provider widget first and then we will return toolbar configurations
   /// don't throw exception if [QuillProvider] is not in the widget tree
   QuillToolbarConfigurations? get quillToolbarConfigurations {
@@ -113,4 +120,20 @@ extension BuildContextExt on BuildContext {
   QuillToolbarBaseButtonOptions get requireQuillToolbarBaseButtonOptions {
     return requireQuillToolbarConfigurations.buttonOptions.base;
   }
+
+  /// return nullable [QuillToolbarBaseButtonOptions]. Since the quill
+  /// quill editor block options is in the [QuillEditorProvider] then we need to
+  /// get the provider widget first and then we will return block options
+  /// throw exception if [QuillEditorProvider] is not in the widget tree
+  QuillEditorElementOptions? get quillEditorElementOptions {
+    return quillEditorConfigurations?.elementOptions;
+  }
+
+  /// return [QuillToolbarBaseButtonOptions] as not null. Since the quill
+  /// quill editor block options is in the [QuillEditorProvider] then we need to
+  /// get the provider widget first and then we will return block options
+  /// don't throw exception if [QuillEditorProvider] is not in the widget tree
+  QuillEditorElementOptions get requireQuillEditorElementOptions {
+    return requireQuillEditorConfigurations.elementOptions;
+  }
 }

lib/src/widgets/text_block.dart

@@ -6,6 +6,7 @@ import '../models/documents/nodes/block.dart';
 import '../models/documents/nodes/line.dart';
 import '../models/structs/vertical_spacing.dart';
 import '../utils/delta.dart';
+import '../utils/extensions/build_context.dart';
 import 'box.dart';
 import 'controller.dart';
 import 'cursor.dart';
@@ -230,8 +231,8 @@ class EditableTextBlock extends StatelessWidget {
         uiBuilder: defaultStyles.lists?.checkboxUIBuilder,
       );
     }
-
-    if (attrs.containsKey(Attribute.codeBlock.key)) {
+    if (attrs.containsKey(Attribute.codeBlock.key) &&
+        context.requireQuillEditorElementOptions.code.enableLineNumbers) {
       return QuillNumberPoint(
         index: index,
         indentLevelCounts: indentLevelCounts,

pubspec.yaml

@@ -1,6 +1,6 @@
 name: flutter_quill
 description: A rich text editor built for the modern Android, iOS, web and desktop platforms. It is the WYSIWYG editor and a Quill component for Flutter.
-version: 7.10.1
+version: 7.10.2
 homepage: https://1o24bbs.com/c/bulletjournal/108
 repository: https://github.com/singerdmx/flutter-quill
 topics: