Slot

BlockSuite extensively uses Slot to manage events that are not DOM-native. You can think of it as a type-safe event emitter or a simplified RxJS Observable:

import { Slot } from '@blocksuite/store';

// Create a new slot
const slot = new Slot<{ name: string }>();

// Subscribe events
slot.on(({ name }) => console.log(name));

// Or alternatively only listen event once
slot.once(({ name }) => console.log(name));

// Emit the event
slot.emit({ name: 'foo' });

To unsubscribe from the slot, simply use the return value of slot.on():

const slot = new Slot();
const disposable = slot.on(myHandler);

// Dispose the subscription
disposable.dispose();

Under the doc instance, you can subscribe to common events using doc.slots:

doc.slots.ready.on(() => {
  // The `doc.root` should be ready to use at this moment
  console.log('doc ready!');
});

doc.addBlock('affine:page');

Moreover, for any node in the block tree, events can be triggered when the node is updated:

const model = doc.root[0];

// Triggered when the `props` of the block model is updated
model.propsUpdated.on(() => updateMyComponent());
// Triggered when the `children` of the block model is updated
model.childrenUpdated.on(() => updateMyComponent());

In the prebuilt AFFiNE editor, which is based on the lit framework, the UI component of each block subscribes to its model updates using this pattern.