Feat: support for customize copy and cut Embeddables to Clipboard

[CatHood0]

Description

Before this PR, we always copy or cut an Embeddable with a empty text, making also more easy to getting back a Embed when the user paste it, but, this could be an issue for users that only want to get the plain text from a Embed. To fix this i add some classes to override this behavior.

CopyCutService and CopyCutServiceProvider

CopyCutService is an interface that let us modify the behavior of getCopyCutAction that let us return some text or an object that will be copied to the Clipboard.

It looks like:

typedef CopyCutAction = Object? Function(dynamic data);

/// An abstraction to make it easy to provide different implementations
/// For copy or cut actions from a Line (just for embeddable blocks)
@immutable
abstract class CopyCutService {
  /// Get the CopyCutAction by the type
  /// of the embeddable (this type is decided by
  /// the property type of that class)
  CopyCutAction? getCopyCutAction(String type);
}

CopyCutServiceProvider it's very similiar to ClipboardServiceProvider. Just provide an instance to be modified and used by any resource of the project.

It looks like:

class CopyCutServiceProvider {
  const CopyCutServiceProvider._();
  static CopyCutService _instance = DefaultCopyCutService();

  static CopyCutService get instance => _instance;

  static void setInstance(CopyCutService service) {
    _instance = service;
  }

  static void setInstanceToDefault() {
    _instance = DefaultCopyCutService();
  }
}

Note

By default CopyCutServiceProvider use DefaultCopyCutService that just return an empty text.

It looks like:

class DefaultCopyCutService extends CopyCutService {
  @override
  CopyCutAction? getCopyCutAction(String type) {
    return (data) => Embed.kObjectReplacementCharacter;
  }
}

Example

If we have a Embeddable like:

class ContentTagEmbed extends Embeddable {
  const ContentTagEmbed(
    String value,
  ) : super(tagType, value);

  static const String tagType = 'content_tag';

  static ContentTagEmbed fromDocument(Document document) => ContentTagEmbed(jsonEncode(document.toDelta().toJson()));

  Document get document => Document.fromJson(jsonDecode(data));
}

To detect this Embed, we just need to create a custom implementation of CopyCutService

class CopyCutServiceTagContent extends CopyCutService {
  
 @override
  CopyCutPlainText? getCopyCutAction(String type) {
    if (type == 'content_tag') {
      return (data) => data.toString();
    } 
    // returning this String maintain the default behavior for others Embed that doesn't need to be plain
    return (data) => '\uFFFC';
  }
}

And after we just need to set this instance to the CopyCutServiceProvider:

CopyCutServiceProvider.setInstance(CopyCutServiceTagContent());

clideo_editor_e7cbeac8d41c4a6d8b55acd082b3cc3f.mp4

Related Issues

• Related How to copy text from a custom widget #2050

• Related toPlainText method from any Embeddable return text that cannot be used outside of the editor #2065

• ✨ 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.

[singerdmx]

Nice

[EchoEllet]

Can we use Object? instead of dynamic?

[CatHood0]

I use dynamic to avoid transforming the data from Embeddable objects. But, i'll change it soon to avoid unexpected behaviors