Update the comments of flutter_quill_extensions

pull/1657/head
Ellet 1 year ago
parent 83a20b69ba
commit 9fa37560f6
  1. 18
      flutter_quill_extensions/lib/flutter_quill_extensions.dart

@ -1,5 +1,3 @@
// ignore_for_file: unused_import
library flutter_quill_extensions; library flutter_quill_extensions;
import 'package:flutter/foundation.dart' show kIsWeb; import 'package:flutter/foundation.dart' show kIsWeb;
@ -15,7 +13,6 @@ import 'embeds/video/editor/video_web_embed.dart';
import 'embeds/video/toolbar/video_button.dart'; import 'embeds/video/toolbar/video_button.dart';
import 'models/config/camera/camera_configurations.dart'; import 'models/config/camera/camera_configurations.dart';
import 'models/config/image/editor/image_configurations.dart'; import 'models/config/image/editor/image_configurations.dart';
import 'models/config/image/editor/image_web_configurations.dart';
import 'models/config/image/toolbar/image_configurations.dart'; import 'models/config/image/toolbar/image_configurations.dart';
import 'models/config/media/media_button_configurations.dart'; import 'models/config/media/media_button_configurations.dart';
import 'models/config/video/editor/video_configurations.dart'; import 'models/config/video/editor/video_configurations.dart';
@ -52,7 +49,7 @@ export 'utils/utils.dart';
class FlutterQuillEmbeds { class FlutterQuillEmbeds {
const FlutterQuillEmbeds._(); const FlutterQuillEmbeds._();
/// Returns a list of embed builders for QuillEditor. /// Returns a list of embed builders for [QuillEditor].
/// ///
/// This method provides a collection of embed builders to enhance the /// This method provides a collection of embed builders to enhance the
/// functionality /// functionality
@ -60,11 +57,6 @@ class FlutterQuillEmbeds {
/// handling various types of /// handling various types of
/// embedded content, such as images, videos, and formulas. /// embedded content, such as images, videos, and formulas.
/// ///
/// **Note:** This method is not intended for web usage.
/// For web-specific embeds,
/// use [editorWebBuilders].
///
///
/// The method returns a list of [EmbedBuilder] objects that can be used with /// The method returns a list of [EmbedBuilder] objects that can be used with
/// QuillEditor /// QuillEditor
/// to enable embedded content features like images, videos, and formulas. /// to enable embedded content features like images, videos, and formulas.
@ -76,8 +68,6 @@ class FlutterQuillEmbeds {
/// ); /// );
/// ``` /// ```
/// ///
/// if you don't want image embed in your quill editor then please pass null
/// to [imageEmbedConfigurations]. same apply to [videoEmbedConfigurations]
static List<EmbedBuilder> editorBuilders({ static List<EmbedBuilder> editorBuilders({
QuillEditorImageEmbedConfigurations? imageEmbedConfigurations = QuillEditorImageEmbedConfigurations? imageEmbedConfigurations =
const QuillEditorImageEmbedConfigurations(), const QuillEditorImageEmbedConfigurations(),
@ -105,10 +95,10 @@ class FlutterQuillEmbeds {
/// Returns a list of embed builders specifically designed for web support. /// Returns a list of embed builders specifically designed for web support.
/// ///
/// [QuillEditorWebImageEmbedBuilder] is the embed builder for handling /// [QuillEditorWebImageEmbedBuilder] is the embed builder for handling
/// images on the web. /// images on the web. this will use <img> tag of HTML
/// ///
/// [QuillEditorWebVideoEmbedBuilder] is the embed builder for handling /// [QuillEditorWebVideoEmbedBuilder] is the embed builder for handling
/// videos iframe on the web. /// videos iframe on the web. this will use <iframe> tag of HTML
/// ///
static List<EmbedBuilder> editorWebBuilders({ static List<EmbedBuilder> editorWebBuilders({
QuillEditorImageEmbedConfigurations? imageEmbedConfigurations = QuillEditorImageEmbedConfigurations? imageEmbedConfigurations =
@ -166,7 +156,6 @@ class FlutterQuillEmbeds {
/// ///
/// ///
/// The returned list contains embed button builders for the Quill toolbar. /// The returned list contains embed button builders for the Quill toolbar.
/// the [formulaButtonOptions] will be disabled by default on web
static List<EmbedButtonBuilder> toolbarButtons({ static List<EmbedButtonBuilder> toolbarButtons({
QuillToolbarImageButtonOptions? imageButtonOptions = QuillToolbarImageButtonOptions? imageButtonOptions =
const QuillToolbarImageButtonOptions(), const QuillToolbarImageButtonOptions(),
@ -194,7 +183,6 @@ class FlutterQuillEmbeds {
controller: controller, controller: controller,
options: cameraButtonOptions, options: cameraButtonOptions,
), ),
// TODO: We will return the support for this later
// if (mediaButtonOptions != null) // if (mediaButtonOptions != null)
// (controller, toolbarIconSize, iconTheme, dialogTheme) => // (controller, toolbarIconSize, iconTheme, dialogTheme) =>
// QuillToolbarMediaButton( // QuillToolbarMediaButton(

Loading…
Cancel
Save