BlockSuite

Appearance

BlockSuite API Documentation / @blocksuite/affine-block-edgeless-text

@blocksuite/affine-block-edgeless-text ​

Classes ​

Extension ​

EdgelessClipboardEdgelessTextConfig ​

Understanding Extensions ​

Extensions provide a way to extend the functionality of a system using dependency injection. They allow you to register services, implementations, and factories in the DI container, which can then be retrieved and used by different parts of the application.

Extensions are particularly useful for:

  • Registering different implementations for different types
  • Creating pluggable architecture where components can be added or removed
  • Managing dependencies between different parts of the application

Usage Example: Fruit Processing System ​

Let's consider a fruit processing system where different types of fruits need different processing methods. We'll show how to implement this using extensions.

Step 1: Define the interfaces ​

ts
interface FruitProcessor {
  process(fruit: Fruit): void;
}

interface Fruit {
  type: string;
  // other properties
}

Step 2: Create a service identifier ​

ts
import { createIdentifier } from '@blocksuite/global/di';

const FruitProcessorProvider = createIdentifier<FruitProcessor>('fruit-processor-provider');

Step 3: Create implementations ​

ts
class AppleProcessor implements FruitProcessor {
  process(fruit: Fruit): void {
    console.log('Slicing apple');
    // Apple-specific processing
  }
}

class BananaProcessor implements FruitProcessor {
  process(fruit: Fruit): void {
    console.log('Peeling banana');
    // Banana-specific processing
  }
}

Step 4: Create an extension factory ​

ts
const FruitProcessorExtension = (
  fruitType: string,
  implementation: new () => FruitProcessor
): ExtensionType => {
  return {
    setup: di => {
      di.addImpl(FruitProcessorProvider(fruitType), implementation);
    }
  };
};

Step 5: Create concrete extensions ​

ts
export const AppleProcessorExtension = FruitProcessorExtension('apple', AppleProcessor);
export const BananaProcessorExtension = FruitProcessorExtension('banana', BananaProcessor);

Step 6: Use the extensions ​

ts
import { Container } from '@blocksuite/global/di';

class FruitProcessingSystem {
  provider: ServiceProvider;

  constructor(extensions: ExtensionType[]) {
    const container = new Container();

    // Set up all extensions
    extensions.forEach(ext => ext.setup(container));

    // Create a provider from the container
    this.provider = container.provider();
  }

  processFruit(fruit: Fruit) {
    // Get the appropriate processor based on fruit type
    const processor = this.provider.get(FruitProcessorProvider(fruit.type));

    // Process the fruit
    processor.process(fruit);
  }
}

// Initialize the system with extensions
const system = new FruitProcessingSystem([
  AppleProcessorExtension,
  BananaProcessorExtension
]);

// Use the system
system.processFruit({ type: 'apple' });  // Output: Slicing apple
system.processFruit({ type: 'banana' }); // Output: Peeling banana

Note: We deliberately used a non-block specific example here. In BlockSuite, the extension pattern can be applied to any entity that can be configured by third parties, not just blocks. This includes different tools in the whiteboard, different column types in database blocks, and many other extensible components. The pattern remains the same regardless of what you're extending.

Extends ​
Constructors ​
Properties ​
key ​

readonly static key: "affine:edgeless-text" = 'affine:edgeless-text'

Overrides ​

EdgelessClipboardConfig.key

Accessors ​
Methods ​
createBlock() ​

createBlock(edgelessText): Promise<string | null>

Parameters ​
edgelessText ​

BlockSnapshot

Returns ​

Promise<string | null>

Overrides ​

EdgelessClipboardConfig.createBlock

Other ​

EdgelessTextBlockComponent ​

Extends ​
Constructors ​
Other ​
childrenContainer ​
checkWidthOverflow() ​

checkWidthOverflow(width): boolean

Parameters ​
width ​

number

Returns ​

boolean

connectedCallback() ​

connectedCallback(): void

Returns ​

void

Overrides ​

GfxBlockComponent.connectedCallback

getCSSTransform() ​

getCSSTransform(): string

Returns ​

string

Overrides ​

GfxBlockComponent.getCSSTransform

getRenderingRect() ​

getRenderingRect(): object

Returns ​

object

h ​

h: number

rotate ​

rotate: number

w ​

w: number | undefined

x ​

x: number = bound.x

y ​

y: number = bound.y

zIndex ​

zIndex: string

Overrides ​

GfxBlockComponent.getRenderingRect

renderGfxBlock() ​

renderGfxBlock(): TemplateResult<1>

Returns ​

TemplateResult<1>

Overrides ​

GfxBlockComponent.renderGfxBlock

renderPageContent() ​

renderPageContent(): TemplateResult<1>

Returns ​

TemplateResult<1>

Overrides ​

GfxBlockComponent.renderPageContent

tryFocusEnd() ​

tryFocusEnd(): void

Returns ​

void

attributes ​
controllers ​
dev-mode ​
lifecycle ​
properties ​
rendering ​
styles ​
styles ​

static styles: CSSResult

Array of styles to apply to the element. The styles should be defined using the css tag function, via constructible stylesheets, or imported from native CSS module scripts.

Note on Content Security Policy:

Element styles are implemented with <style> tags when the browser doesn't support adopted StyleSheets. To use such <style> tags with the style-src CSP directive, the style-src value must either include 'unsafe-inline' or nonce-<base64-value> with <base64-value> replaced be a server-generated nonce.

To provide a nonce to use on generated <style> elements, set window.litNonce to a server-generated nonce in your page's HTML, before loading application code:

html
<script>
  // Generated and unique per request:
  window.litNonce = 'a1b2c3d4';
</script>
Nocollapse ​
Overrides ​

GfxBlockComponent.styles

updates ​
firstUpdated() ​

firstUpdated(props): void

Invoked when the element is first updated. Implement to perform one time work on the element after update.

ts
firstUpdated() {
  this.renderRoot.getElementById('my-text-area').focus();
}

Setting properties inside this method will trigger the element to update again after this update cycle completes.

Parameters ​
props ​

Map<string, unknown>

Returns ​

void

Overrides ​

GfxBlockComponent.firstUpdated

Variables ​

EdgelessTextInteraction ​

const EdgelessTextInteraction: ExtensionType

edgelessTextToolbarConfig ​

const edgelessTextToolbarConfig: object

Type Declaration ​

actions ​

readonly actions: [{ content: (ctx) => TemplateResult<1> | null; id: "a.font"; }, { content: (ctx) => TemplateResult<1> | null; id: "b.text-color"; }, { content: (ctx) => TemplateResult<1> | null; id: "c.font-style"; }, { content: (ctx) => TemplateResult<1> | null; id: "d.font-size"; when: boolean; }, { content: (ctx) => TemplateResult<1> | null; id: "e.alignment"; }]

when() ​

readonly when: (ctx) => boolean

Parameters ​
ctx ​

ToolbarContext

Returns ​

boolean

edgelessTextToolbarExtension ​

const edgelessTextToolbarExtension: ExtensionType

Copyright © 2022-present Toeverything