Skip to content

API

Once you've initialised a new constructor, you can manipulate it using the following methods

Crate APIs

Toggle

Definition

type toggle = (open?: boolean) => void

Toggles the widget's visibility, with an optional param to set it.

Usage

// Toggle
crate.toggle()

// Toggle open
crate.toggle(true)

// Toggle closed
crate.toggle(false)

Try it:


Notify

Definition

type notify = (
  content:
    | string
    | Notification & {
      content: string
      timeout?: number
    }
  ) => { hide: Function; delete: Function }

Displays a notification message to the user. Markdown supported

Usage

// Hello world
crate.notify(`**hello** world`)

// Display for 2 seconds + custom avatar
crate.notify({
  content: '`2 seconds`',
  timeout: 2000,
  avatar: 'https://cdn.samdd.me/samdd-logo/variations/logo.png'
})

// Programmatically hide notification
const notification = crate.notify({
  content: 'Test',
  timeout: false
})
/* business logic */
notification.hide()

Try it:


Update options

Definition

type setOptions = (newOptions: Options) => Options

Updates the options for crate in real time. Available options

Usage

// Update an option by mutating it
crate.options.color = '#'+Math.random().toString(16).slice(2, 8) // random color

// Update options by passing an object
crate.setOptions({
  location: [-Math.random() * 200), 'right'], // Random position
})

Try it:


Visibility

Definition

type hide = () => void
type show = () => void

Hides / un-hides the crate instance, eg. the button, notifications and widget

Usage

// Button will now disappear
crate.hide()

// Button will now re-appear
crate.show()

Try it:


Embed API

Emit

Definition

type emit = <Event>(event: Event, data: Events[Event]) => void

Emits an event to the embed-api

Usage

// Send a message on the active Discord channel
crate.emit('sendMessage', 'hi')

// Send a message on a specific Discord channel
crate.emit('sendMessage', {
  channel: '123456789',
  message: 'hi'
})

On

Definition

type on = <Event>(event: Event, (data: Events[Event]) => void) => void

Listens for a specific event from the embed-api

Usage

// Listens for when the user has signed in
crate.on('signIn', (user) => {
  console.log(`Guest signed in as ${user.name}`, user)
})

// Listen for discord message events
crate.on('message', ({ message, channel }) => {
  console.log(`New message in ${channel}`, message)
})

// Listen for discord message delete events
crate.on('messageDelete', ({ channel, id }) => {
  console.log(`Message in ${channel} with an ID of ${id}, was deleted`)
})