BlockSuite API Documentation / @blocksuite/blocks / EmbedGithubModel

Class: EmbedGithubModel

Extends

• EmbedGithubModel_base

Constructors

new EmbedGithubModel()

new EmbedGithubModel(): EmbedGithubModel

Returns

EmbedGithubModel

Inherited from

EmbedGithubModel_base.constructor

Defined in

packages/affine/model/dist/blocks/embed/github/github-model.d.ts:22

Properties

[modelLabel]

[modelLabel]: object & EmbedGithubBlockUrlData & GfxCompatibleProps

Type declaration

caption

caption: null | string

githubId

githubId: string

githubType

githubType: "issue" | "pr"

owner

owner: string

repo

repo: string

style

style: EmbedCardStyle

url

url: string

Inherited from

EmbedGithubModel_base.[modelLabel]

Defined in

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

---

assignees

assignees: null | string[]

Inherited from

EmbedGithubModel_base.assignees

Defined in

packages/affine/model/dist/blocks/embed/github/github-model.d.ts:9

---

assignees$

assignees$: Signal<null | string[]>

Inherited from

EmbedGithubModel_base.assignees$

---

caption

caption: null | string

Inherited from

EmbedGithubModel_base.caption

Defined in

packages/affine/model/dist/blocks/embed/github/github-model.d.ts:29

---

caption$

caption$: Signal<null | string>

Inherited from

EmbedGithubModel_base.caption$

---

childMap

childMap: ReadonlySignal<Map<string, number>>

Inherited from

EmbedGithubModel_base.childMap

Defined in

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

---

connectable

connectable: boolean

Inherited from

EmbedGithubModel_base.connectable

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:33

---

created

created: Slot<void>

Inherited from

EmbedGithubModel_base.created

Defined in

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

---

createdAt

createdAt: null | string

Inherited from

EmbedGithubModel_base.createdAt

Defined in

packages/affine/model/dist/blocks/embed/github/github-model.d.ts:8

---

createdAt$

createdAt$: Signal<null | string>

Inherited from

EmbedGithubModel_base.createdAt$

---

deleted

deleted: Slot<void>

Inherited from

EmbedGithubModel_base.deleted

Defined in

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

---

description

description: null | string

Inherited from

EmbedGithubModel_base.description

Defined in

packages/affine/model/dist/blocks/embed/github/github-model.d.ts:7

---

description$

description$: Signal<null | string>

Inherited from

EmbedGithubModel_base.description$

---

flavour

flavour: string

Inherited from

EmbedGithubModel_base.flavour

Defined in

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

---

githubId

githubId: string

Inherited from

EmbedGithubModel_base.githubId

Defined in

packages/affine/model/dist/blocks/embed/github/github-model.d.ts:27

---

githubId$

githubId$: Signal<string>

Inherited from

EmbedGithubModel_base.githubId$

---

githubType

githubType: "issue" | "pr"

Inherited from

EmbedGithubModel_base.githubType

Defined in

packages/affine/model/dist/blocks/embed/github/github-model.d.ts:26

---

githubType$

githubType$: Signal<"issue" | "pr">

Inherited from

EmbedGithubModel_base.githubType$

---

id

id: string

Inherited from

EmbedGithubModel_base.id

Defined in

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

---

image

image: null | string

Inherited from

EmbedGithubModel_base.image

Defined in

packages/affine/model/dist/blocks/embed/github/github-model.d.ts:3

---

image$

image$: Signal<null | string>

Inherited from

EmbedGithubModel_base.image$

---

index

index: string

Inherited from

EmbedGithubModel_base.index

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:13

---

index$

index$: Signal<string>

Inherited from

EmbedGithubModel_base.index$

---

isEmpty

isEmpty: ReadonlySignal<boolean>

Inherited from

EmbedGithubModel_base.isEmpty

Defined in

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

---

keys

keys: string[]

Inherited from

EmbedGithubModel_base.keys

Defined in

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

---

lockedBySelf?

optional lockedBySelf: boolean

Inherited from

EmbedGithubModel_base.lockedBySelf

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:14

---

lockedBySelf$

lockedBySelf$: Signal<undefined | boolean>

Inherited from

EmbedGithubModel_base.lockedBySelf$

---

owner

owner: string

Inherited from

EmbedGithubModel_base.owner

Defined in

packages/affine/model/dist/blocks/embed/github/github-model.d.ts:24

---

owner$

owner$: Signal<string>

Inherited from

EmbedGithubModel_base.owner$

---

page

page: Doc

Deprecated

use doc instead

Inherited from

EmbedGithubModel_base.page

Defined in

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

---

pop()

pop: (prop) => void

Parameters

prop

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

Returns

void

Inherited from

EmbedGithubModel_base.pop

Defined in

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

---

propsUpdated

propsUpdated: Slot<{ key: string; }>

Inherited from

EmbedGithubModel_base.propsUpdated

Defined in

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

---

repo

repo: string

Inherited from

EmbedGithubModel_base.repo

Defined in

packages/affine/model/dist/blocks/embed/github/github-model.d.ts:25

---

repo$

repo$: Signal<string>

Inherited from

EmbedGithubModel_base.repo$

---

role

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

Inherited from

EmbedGithubModel_base.role

Defined in

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

---

rotate

rotate: number

Inherited from

EmbedGithubModel_base.rotate

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:34

---

stash()

stash: (prop) => void

Parameters

prop

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

Returns

void

Inherited from

EmbedGithubModel_base.stash

Defined in

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

---

status

status: null | string

Inherited from

EmbedGithubModel_base.status

Defined in

packages/affine/model/dist/blocks/embed/github/github-model.d.ts:4

---

status$

status$: Signal<null | string>

Inherited from

EmbedGithubModel_base.status$

---

statusReason

statusReason: null | string

Inherited from

EmbedGithubModel_base.statusReason

Defined in

packages/affine/model/dist/blocks/embed/github/github-model.d.ts:5

---

statusReason$

statusReason$: Signal<null | string>

Inherited from

EmbedGithubModel_base.statusReason$

---

style

style: EmbedCardStyle

Inherited from

EmbedGithubModel_base.style

Defined in

packages/affine/model/dist/blocks/embed/github/github-model.d.ts:23

---

style$

style$: Signal<EmbedCardStyle>

Inherited from

EmbedGithubModel_base.style$

---

text?

optional text: Text

Inherited from

EmbedGithubModel_base.text

Defined in

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

---

title

title: null | string

Inherited from

EmbedGithubModel_base.title

Defined in

packages/affine/model/dist/blocks/embed/github/github-model.d.ts:6

---

title$

title$: Signal<null | string>

Inherited from

EmbedGithubModel_base.title$

---

url

url: string

Inherited from

EmbedGithubModel_base.url

Defined in

packages/affine/model/dist/blocks/embed/github/github-model.d.ts:28

---

url$

url$: Signal<string>

Inherited from

EmbedGithubModel_base.url$

---

version

version: number

Inherited from

EmbedGithubModel_base.version

Defined in

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

---

xywh

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

Inherited from

EmbedGithubModel_base.xywh

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:12

---

xywh$

xywh$: Signal<`[${number},${number},${number},${number}]`>

Inherited from

EmbedGithubModel_base.xywh$

---

yBlock

yBlock: YBlock

Inherited from

EmbedGithubModel_base.yBlock

Defined in

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

Accessors

children

Get Signature

get children(): BlockModel<object, SignaledProps<object>>[]

Returns

BlockModel<object, SignaledProps<object>>[]

Inherited from

EmbedGithubModel_base.children

Defined in

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

---

deserializedXYWH

Get Signature

get deserializedXYWH(): XYWH

Returns

XYWH

Inherited from

EmbedGithubModel_base.deserializedXYWH

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:35

---

doc

Get Signature

get doc(): Doc

Returns

Doc

Set Signature

set doc(doc): void

Parameters

doc

Doc

Returns

void

Inherited from

EmbedGithubModel_base.doc

Defined in

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

---

elementBound

Get Signature

get elementBound(): Bound

Returns

Bound

Inherited from

EmbedGithubModel_base.elementBound

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:36

---

externalBound

Get Signature

get externalBound(): null | Bound

Returns

null | Bound

Inherited from

EmbedGithubModel_base.externalBound

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:37

---

externalXYWH

Get Signature

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

Returns

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

Set Signature

set externalXYWH(xywh): void

Parameters

xywh

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

Returns

void

Inherited from

EmbedGithubModel_base.externalXYWH

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:38

---

group

Get Signature

get group(): null | GfxGroupModel

Returns

null | GfxGroupModel

Inherited from

EmbedGithubModel_base.group

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:40

---

groups

Get Signature

get groups(): GfxGroupModel[]

Returns

GfxGroupModel[]

Inherited from

EmbedGithubModel_base.groups

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:41

---

h

Get Signature

get h(): number

Returns

number

Inherited from

EmbedGithubModel_base.h

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:42

---

parent

Get Signature

get parent(): null | BlockModel<object, SignaledProps<object>>

Returns

null | BlockModel<object, SignaledProps<object>>

Inherited from

EmbedGithubModel_base.parent

Defined in

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

---

surface

Get Signature

get surface(): null | SurfaceBlockModel

Returns

null | SurfaceBlockModel

Inherited from

EmbedGithubModel_base.surface

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:43

---

w

Get Signature

get w(): number

Returns

number

Inherited from

EmbedGithubModel_base.w

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:44

---

x

Get Signature

get x(): number

Returns

number

Inherited from

EmbedGithubModel_base.x

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:45

---

y

Get Signature

get y(): number

Returns

number

Inherited from

EmbedGithubModel_base.y

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:46

Methods

[dispose]()

[dispose](): void

Returns

void

Inherited from

EmbedGithubModel_base.[dispose]

Defined in

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

---

containsBound()

containsBound(bounds): boolean

Parameters

bounds

Bound

Returns

boolean

Inherited from

EmbedGithubModel_base.containsBound

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:47

---

dispose()

dispose(): void

Returns

void

Inherited from

EmbedGithubModel_base.dispose

Defined in

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

---

firstChild()

firstChild(): null | BlockModel<object, SignaledProps<object>>

Returns

null | BlockModel<object, SignaledProps<object>>

Inherited from

EmbedGithubModel_base.firstChild

Defined in

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

---

getLineIntersections()

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

Parameters

start

IVec

end

IVec

Returns

null | PointLocation[]

Inherited from

EmbedGithubModel_base.getLineIntersections

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:48

---

getNearestPoint()

getNearestPoint(point): IVec

Parameters

point

IVec

Returns

IVec

Inherited from

EmbedGithubModel_base.getNearestPoint

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:49

---

getRelativePointLocation()

getRelativePointLocation(relativePoint): PointLocation

Parameters

relativePoint

IVec

Returns

PointLocation

Inherited from

EmbedGithubModel_base.getRelativePointLocation

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:50

---

includesPoint()

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

Parameters

x

number

y

number

_

PointTestOptions

__

EditorHost

Returns

boolean

Inherited from

EmbedGithubModel_base.includesPoint

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:51

---

intersectsBound()

intersectsBound(bound): boolean

Parameters

bound

Bound

Returns

boolean

Inherited from

EmbedGithubModel_base.intersectsBound

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:52

---

isLocked()

isLocked(): boolean

Check if the element is locked. It will check the lock status of the element and its ancestors.

Returns

boolean

Inherited from

EmbedGithubModel_base.isLocked

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:53

---

isLockedByAncestor()

isLockedByAncestor(): boolean

Returns

boolean

Inherited from

EmbedGithubModel_base.isLockedByAncestor

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:54

---

isLockedBySelf()

isLockedBySelf(): boolean

Returns

boolean

Inherited from

EmbedGithubModel_base.isLockedBySelf

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:55

---

lastChild()

lastChild(): null | BlockModel<object, SignaledProps<object>>

Returns

null | BlockModel<object, SignaledProps<object>>

Inherited from

EmbedGithubModel_base.lastChild

Defined in

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

---

lock()

lock(): void

Returns

void

Inherited from

EmbedGithubModel_base.lock

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:56

---

unlock()

unlock(): void

Returns

void

Inherited from

EmbedGithubModel_base.unlock

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:57