Skip to content

BlockSuite API Documentation / @blocksuite/blocks / EmbedGithubModel

Class: EmbedGithubModel

Extends

Constructors

new EmbedGithubModel()

new EmbedGithubModel(): EmbedGithubModel

Returns

EmbedGithubModel

Inherited from

EdgelessBlock.constructor

Source

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

Properties

[modelLabel]

[modelLabel]: object & EmbedGithubBlockUrlData & EdgelessSelectableProps

Type declaration

caption

caption: null | string

githubId

githubId: string

githubType

githubType: "pr" | "issue"

owner

owner: string

repo

repo: string

style

style: EmbedCardStyle

url

url: string

Inherited from

EdgelessBlock.[modelLabel]

Source

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


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

EdgelessBlock.childrenUpdated

Source

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


connectable

connectable: boolean = true

Inherited from

EdgelessBlock.connectable

Source

packages/blocks/src/root-block/edgeless/type.ts:80


created

created: Slot<void>

Inherited from

EdgelessBlock.created

Source

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


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

EdgelessBlock.deleted

Source

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


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

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

EdgelessBlock.id

Source

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


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

EdgelessBlock.index

Source

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


keys

keys: string[]

Inherited from

EdgelessBlock.keys

Source

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


owner

owner: string

Inherited from

defineEmbedModel<EmbedGithubBlockProps>( BlockModel ).owner

Source

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


page

page: Doc

Deprecated

use doc instead

Inherited from

EdgelessBlock.page

Source

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


pop()

pop: (prop) => void

Parameters

prop: "status" | "image" | "description" | "url" | "style" | "xywh" | "index" | "title" | "caption" | "owner" | "repo" | "githubType" | "githubId" | "statusReason" | "createdAt" | "assignees"

Returns

void

Inherited from

EdgelessBlock.pop

Source

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


propsUpdated

propsUpdated: Slot<object>

Type declaration

key

key: string

Inherited from

EdgelessBlock.propsUpdated

Source

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


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

EdgelessBlock.role

Source

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


rotate

rotate: number = 0

Inherited from

EdgelessBlock.rotate

Source

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


stash()

stash: (prop) => void

Parameters

prop: "status" | "image" | "description" | "url" | "style" | "xywh" | "index" | "title" | "caption" | "owner" | "repo" | "githubType" | "githubId" | "statusReason" | "createdAt" | "assignees"

Returns

void

Inherited from

EdgelessBlock.stash

Source

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


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?

optional text: Text

Inherited from

EdgelessBlock.text

Source

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


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

EdgelessBlock.version

Source

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


xywh

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

Inherited from

EdgelessBlock.xywh

Source

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


yBlock

yBlock: YBlock

Inherited from

EdgelessBlock.yBlock

Source

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

Accessors

childMap

get childMap(): Map<string, number>

Returns

Map<string, number>

Source

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


children

get children(): BlockModel<object>[]

Returns

BlockModel<object>[]

Source

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


doc

get doc(): Doc

set doc(doc): void

Parameters

doc: Doc

Returns

Doc

Source

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


elementBound

get elementBound(): Bound

Returns

Bound

Source

packages/blocks/src/root-block/edgeless/type.ts:97


externalBound

get externalBound(): null | Bound

Returns

null | Bound

Source

packages/blocks/src/root-block/edgeless/type.ts:93


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/root-block/edgeless/type.ts:85


group

get group(): null | GroupLikeModel<BaseProps>

Returns

null | GroupLikeModel<BaseProps>

Source

packages/blocks/src/root-block/edgeless/type.ts:159


groups

get groups(): GroupLikeModel<BaseProps>[]

Returns

GroupLikeModel<BaseProps>[]

Source

packages/blocks/src/root-block/edgeless/type.ts:167

Methods

boxSelect()

boxSelect(bound): boolean

Parameters

bound: Bound

Returns

boolean

Inherited from

EdgelessBlock.boxSelect

Source

packages/blocks/src/root-block/edgeless/type.ts:150


containedByBounds()

containedByBounds(bounds): boolean

Parameters

bounds: Bound

Returns

boolean

Inherited from

EdgelessBlock.containedByBounds

Source

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


dispose()

dispose(): void

Returns

void

Inherited from

EdgelessBlock.dispose

Source

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


firstChild()

firstChild(): null | BlockModel<object>

Returns

null | BlockModel<object>

Inherited from

EdgelessBlock.firstChild

Source

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


getNearestPoint()

getNearestPoint(point): IVec

Parameters

point: IVec

Returns

IVec

Inherited from

EdgelessBlock.getNearestPoint

Source

packages/blocks/src/root-block/edgeless/type.ts:119


getRelativePointLocation()

getRelativePointLocation(relativePoint): PointLocation

Parameters

relativePoint: IVec

Returns

PointLocation

Inherited from

EdgelessBlock.getRelativePointLocation

Source

packages/blocks/src/root-block/edgeless/type.ts:136


hitTest()

hitTest(x, y, _, __): boolean

Parameters

x: number

y: number

_: HitTestOptions

__: EditorHost

Returns

boolean

Inherited from

EdgelessBlock.hitTest

Source

packages/blocks/src/root-block/edgeless/type.ts:102


intersectWithLine()

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

Parameters

start: IVec

end: IVec

Returns

null | PointLocation[]

Inherited from

EdgelessBlock.intersectWithLine

Source

packages/blocks/src/root-block/edgeless/type.ts:127


isEmpty()

isEmpty(): boolean

Returns

boolean

Inherited from

EdgelessBlock.isEmpty

Source

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


lastChild()

lastChild(): null | BlockModel<object>

Returns

null | BlockModel<object>

Inherited from

EdgelessBlock.lastChild

Source

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