BlockSuite API Documentation / @blocksuite/blocks / EmbedGithubModel

Class: EmbedGithubModel

Extends

EdgelessBlock<Object & EmbedGithubBlockUrlData & EdgelessSelectableProps, this>

Constructors

new EmbedGithubModel(undefined)

new EmbedGithubModel(): EmbedGithubModel

Returns

EmbedGithubModel

Inherited from

@blocksuite/blocks.EdgelessBlock.constructor

Source

packages/framework/store/dist/schema/base.d.ts:100

Properties

assignees

assignees: null | string[]

Inherited from

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).assignees

Source

packages/blocks/src/embed-github-block/embed-github-model.ts:16

caption

caption: null | string

Inherited from

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).caption

Source

packages/blocks/src/embed-github-block/embed-github-model.ts:33

childrenUpdated

childrenUpdated: Slot<void>

Inherited from

@blocksuite/blocks.EdgelessBlock.childrenUpdated

Source

packages/framework/store/dist/schema/base.d.ts:117

connectable

connectable: boolean = true

Inherited from

@blocksuite/blocks.EdgelessBlock.connectable

Source

packages/blocks/src/page-block/edgeless/type.ts:68

created

created: Slot<void>

Inherited from

@blocksuite/blocks.EdgelessBlock.created

Source

packages/framework/store/dist/schema/base.d.ts:112

createdAt

createdAt: null | string

Inherited from

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).createdAt

Source

packages/blocks/src/embed-github-block/embed-github-model.ts:15

deleted

deleted: Slot<void>

Inherited from

@blocksuite/blocks.EdgelessBlock.deleted

Source

packages/framework/store/dist/schema/base.d.ts:113

description

description: null | string

Inherited from

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).description

Source

packages/blocks/src/embed-github-block/embed-github-model.ts:14

flavour

flavour: string

Inherited from

@blocksuite/blocks.EdgelessBlock.flavour

Source

packages/framework/store/dist/schema/base.d.ts:103

githubId

githubId: string

Inherited from

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).githubId

Source

packages/blocks/src/embed-github-block/embed-github-model.ts:31

githubType

githubType: "pr" | "issue"

Inherited from

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).githubType

Source

packages/blocks/src/embed-github-block/embed-github-model.ts:30

id

id: string

Inherited from

@blocksuite/blocks.EdgelessBlock.id

Source

packages/framework/store/dist/schema/base.d.ts:106

image

image: null | string

Inherited from

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).image

Source

packages/blocks/src/embed-github-block/embed-github-model.ts:10

index

index: string

Inherited from

@blocksuite/blocks.EdgelessBlock.index

Source

packages/blocks/src/_common/edgeless/mixin/edgeless-selectable.ts:9

keys

keys: string[]

Inherited from

@blocksuite/blocks.EdgelessBlock.keys

Source

packages/framework/store/dist/schema/base.d.ts:108

owner

owner: string

Inherited from

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).owner

Source

packages/blocks/src/embed-github-block/embed-github-model.ts:28

pop

pop: (prop) => void

Parameters

Returns

void

Inherited from

@blocksuite/blocks.EdgelessBlock.pop

Source

packages/framework/store/dist/schema/base.d.ts:110

propsUpdated

propsUpdated: Slot<Object>

Type declaration

key

key: string

Inherited from

@blocksuite/blocks.EdgelessBlock.propsUpdated

Source

packages/framework/store/dist/schema/base.d.ts:114

repo

repo: string

Inherited from

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).repo

Source

packages/blocks/src/embed-github-block/embed-github-model.ts:29

role

role: "root" | "hub" | "content"

Inherited from

@blocksuite/blocks.EdgelessBlock.role

Source

packages/framework/store/dist/schema/base.d.ts:104

rotate

rotate: number = 0

Inherited from

@blocksuite/blocks.EdgelessBlock.rotate

Source

packages/blocks/src/page-block/edgeless/type.ts:69

stash

stash: (prop) => void

Parameters

Returns

void

Inherited from

@blocksuite/blocks.EdgelessBlock.stash

Source

packages/framework/store/dist/schema/base.d.ts:109

status

status: null | string

Inherited from

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).status

Source

packages/blocks/src/embed-github-block/embed-github-model.ts:11

statusReason

statusReason: null | string

Inherited from

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).statusReason

Source

packages/blocks/src/embed-github-block/embed-github-model.ts:12

style

style: EmbedCardStyle

Inherited from

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).style

Source

packages/blocks/src/embed-github-block/embed-github-model.ts:27

text?

text?: Text

Inherited from

@blocksuite/blocks.EdgelessBlock.text

Source

packages/framework/store/dist/schema/base.d.ts:111

title

title: null | string

Inherited from

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).title

Source

packages/blocks/src/embed-github-block/embed-github-model.ts:13

url

url: string

Inherited from

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).url

Source

packages/blocks/src/embed-github-block/embed-github-model.ts:32

version

version: number

Inherited from

@blocksuite/blocks.EdgelessBlock.version

Source

packages/framework/store/dist/schema/base.d.ts:102

xywh

xywh: `[${number},${number},${number},${number}]`

Inherited from

@blocksuite/blocks.EdgelessBlock.xywh

Source

packages/blocks/src/_common/edgeless/mixin/edgeless-selectable.ts:8

yBlock

yBlock: YBlock

Inherited from

@blocksuite/blocks.EdgelessBlock.yBlock

Source

packages/framework/store/dist/schema/base.d.ts:107

Accessors

childMap

get childMap(): Map<string, number>

Returns

Map<string, number>

Source

packages/framework/store/dist/schema/base.d.ts:118

children

get children(): BlockModel<object>[]

Returns

BlockModel<object>[]

Source

packages/framework/store/dist/schema/base.d.ts:119

elementBound

get elementBound(): Bound

Returns

Bound

Source

packages/blocks/src/page-block/edgeless/type.ts:85

externalBound

get externalBound(): null | Bound

Returns

null | Bound

Source

packages/blocks/src/page-block/edgeless/type.ts:81

externalXYWH

get externalXYWH(): undefined | `[${number},${number},${number},${number}]`

set externalXYWH(xywh): void

Parameters

• xywh: undefined | `[${number},${number},${number},${number}]`

Returns

undefined | `[${number},${number},${number},${number}]`

Source

packages/blocks/src/page-block/edgeless/type.ts:73

group

get group(): null | GroupElementModel

Returns

null | GroupElementModel

Source

packages/blocks/src/page-block/edgeless/type.ts:147

groups

get groups(): GroupElementModel[]

Returns

GroupElementModel[]

Source

packages/blocks/src/page-block/edgeless/type.ts:155

Methods

boxSelect()

boxSelect(bound): boolean

Parameters

• bound: Bound

Returns

boolean

Inherited from

@blocksuite/blocks.EdgelessBlock.boxSelect

Source

packages/blocks/src/page-block/edgeless/type.ts:138

clone()

clone(): this

Returns

this

Inherited from

@blocksuite/blocks.EdgelessBlock.clone

Source

packages/framework/store/dist/schema/base.d.ts:125

containedByBounds()

containedByBounds(bounds): boolean

Parameters

• bounds: Bound

Returns

boolean

Inherited from

@blocksuite/blocks.EdgelessBlock.containedByBounds

Source

packages/blocks/src/page-block/edgeless/type.ts:95

dispose()

dispose(): void

Returns

void

Inherited from

@blocksuite/blocks.EdgelessBlock.dispose

Source

packages/framework/store/dist/schema/base.d.ts:124

firstChild()

firstChild(): null | BlockModel<object>

Returns

null | BlockModel<object>

Inherited from

@blocksuite/blocks.EdgelessBlock.firstChild

Source

packages/framework/store/dist/schema/base.d.ts:121

getNearestPoint()

getNearestPoint(point): IVec

Parameters

• point: IVec

Returns

IVec

Inherited from

@blocksuite/blocks.EdgelessBlock.getNearestPoint

Source

packages/blocks/src/page-block/edgeless/type.ts:107

getRelativePointLocation()

getRelativePointLocation(relativePoint): PointLocation

Parameters

• relativePoint: IVec

Returns

PointLocation

Inherited from

@blocksuite/blocks.EdgelessBlock.getRelativePointLocation

Source

packages/blocks/src/page-block/edgeless/type.ts:124

hitTest()

hitTest(x, y, _): boolean

Parameters

• x: number

• y: number

• _: HitTestOptions

Returns

boolean

Inherited from

@blocksuite/blocks.EdgelessBlock.hitTest

Source

packages/blocks/src/page-block/edgeless/type.ts:90

intersectWithLine()

intersectWithLine(start, end): null | PointLocation[]

Parameters

• start: IVec

• end: IVec

Returns

null | PointLocation[]

Inherited from

@blocksuite/blocks.EdgelessBlock.intersectWithLine

Source

packages/blocks/src/page-block/edgeless/type.ts:115

isEmpty()

isEmpty(): boolean

Returns

boolean

Inherited from

@blocksuite/blocks.EdgelessBlock.isEmpty

Source

packages/framework/store/dist/schema/base.d.ts:120

lastChild()

lastChild(): null | BlockModel<object>

Returns

null | BlockModel<object>

Inherited from

@blocksuite/blocks.EdgelessBlock.lastChild

Source

packages/framework/store/dist/schema/base.d.ts:122

lastItem()

lastItem(): null | BlockModel<object>

Returns

null | BlockModel<object>

Inherited from

@blocksuite/blocks.EdgelessBlock.lastItem

Source

packages/framework/store/dist/schema/base.d.ts:123

Generated using TypeDoc and typedoc-plugin-markdown.

Class: EmbedGithubModel ​

Extends ​

Constructors ​

new EmbedGithubModel(undefined) ​

Returns ​

Inherited from ​

Source ​

Properties ​

assignees ​

Inherited from ​

Source ​

caption ​

Inherited from ​

Source ​

childrenUpdated ​

Inherited from ​

Source ​

connectable ​

Inherited from ​

Source ​

created ​

Inherited from ​

Source ​

createdAt ​

Inherited from ​

Source ​

deleted ​

Inherited from ​

Source ​

description ​

Inherited from ​

Source ​

flavour ​

Inherited from ​

Source ​

githubId ​

Inherited from ​

Source ​

githubType ​

Inherited from ​

Source ​

id ​

Inherited from ​

Source ​

image ​

Inherited from ​

Source ​

index ​

Inherited from ​

Source ​

keys ​

Inherited from ​

Source ​

owner ​

Inherited from ​

Source ​

page ​

Inherited from ​

Source ​

pop ​

Parameters ​

Returns ​

Inherited from ​

Source ​

propsUpdated ​

Type declaration ​

key ​

Inherited from ​

Source ​

repo ​

Inherited from ​

Source ​

role ​

Inherited from ​

Source ​

rotate ​

Inherited from ​

Source ​

stash ​

Parameters ​

Class: EmbedGithubModel

Extends

Constructors

new EmbedGithubModel(undefined)

Returns

Inherited from

Source

Properties

assignees

Inherited from

Source

caption

Inherited from

Source

childrenUpdated

Inherited from

Source

connectable

Inherited from

Source

created

Inherited from

Source

createdAt

Inherited from

Source

deleted

Inherited from

Source

description

Inherited from

Source

flavour

Inherited from

Source

githubId

Inherited from

Source

githubType

Inherited from

Source

id

Inherited from

Source

image

Inherited from

Source

index

Inherited from

Source

keys

Inherited from

Source

owner

Inherited from

Source

page

Inherited from

Source

pop

Parameters

Returns

Inherited from

Source

propsUpdated

Type declaration

key

Inherited from

Source

repo

Inherited from

Source

role

Inherited from

Source

rotate

Inherited from

Source

stash

Parameters