icon

const icon: object

Defined in: src/helpers/file.helpers.ts:113

Helpers that create icon objects: emoji, external URL, file upload, native icon, or custom emoji.

Type Declaration

customEmoji

customEmoji: (id) => CustomEmojiIconRef = customEmojiIcon

Create a custom emoji icon object, referencing a workspace custom emoji by id.

Parameters

id

string

Returns

CustomEmojiIconRef

Example

icon.customEmoji('emoji-id')

emoji

emoji: (emoji) => EmojiIcon = emojiIcon

Create an emoji icon object.

Parameters

emoji

string

Returns

EmojiIcon

Example

icon.emoji('🚀')

external

external: (url) => ExternalRef = externalIcon

Create an external file icon object.

Parameters

url

string

Returns

ExternalRef

Example

icon.external('https://example.com/icon.png')

fileUpload

fileUpload: (id) => FileUploadRef = fileUploadIcon

Create a file-upload icon object.

Parameters

id

string

Returns

FileUploadRef

Example

icon.fileUpload('upload-id')

native

native: (name, color?) => NativeIconRef = nativeIcon

Create a native (icon-picker) icon object.

Parameters

name

string

color?

"blue" | "brown" | "gray" | "green" | "orange" | "pink" | "purple" | "red" | "yellow" | "lightgray"

Returns

NativeIconRef

Example

icon.native('star circle', 'blue')

Example

import { icon } from '@visus-io/notion-sdk-ts';

notion.pages.create({
  parent: { page_id: 'page-id' },
  icon: icon.emoji('📝'),
  // ...
});