@getcanary/web

npm (@1.0.12)

TIP

For visual reference and code example, please refer to our Storybook.

Anything missing here?

This page is generated from custom-elements-manifest.

If you find something missing here, there's three places to fix it:

1. CEM.vue for rendering the data.
2. Each component's source code for adding the missing data.
3. vite.config.ts for adding the missing component.

Or, you can open an issue.

canary-root

source

Imports

• canary-styles

Slots

• Default

Attributes

• frameworkFramework
• querystring

canary-styles

source

Slots

• Default

Attributes

• frameworkFramework
• themeThemeContext

CSS Properties

• --canary-color-primary-cChroma of primary color
• --canary-color-primary-hHue of primary color
• --canary-color-gray-cChroma of gray color
• --canary-color-gray-hHue of gray color
• --canary-color-backdrop-overlayColor of backdrop overlay
• --canary-font-family-baseFont family of base
• --canary-font-family-monoFont family of mono

canary-provider-mock

source

canary-provider-cloud

source

Attributes

• api-basestring
• api-keystring
• project-keystring

canary-provider-pagefind

source

Attributes

• optionsOptions

canary-provider-vitepress-minisearch

source

Attributes

• localeIndexstring
• miniSearchOptionsany

canary-callout

source

Attributes

• forceShowboolean
• keywordsstring[]
• urlstring
• messagestring

canary-callout-cal

source

Imports

• canary-callout
• canary-logo-cal

Attributes

• forceShowboolean
• keywordsstring[]
• urlstring
• messagestring

canary-callout-calendly

source

Imports

• canary-callout
• canary-logo-calendly

Attributes

• forceShowboolean
• keywordsstring[]
• urlstring
• messagestring

canary-callout-slack

source

Imports

• canary-callout
• canary-logo-slack

Attributes

• forceShowboolean
• keywordsstring[]
• urlstring
• messagestring

canary-callout-discord

source

Imports

• canary-callout
• canary-logo-discord

Attributes

• forceShowboolean
• keywordsstring[]
• urlstring
• messagestring

canary-logo-cal

source

canary-logo-calendly

source

canary-logo-discord

source

canary-logo-github

source

canary-logo-slack

source

canary-modal

source

Imports

• canary-dialog

canary-content

source

Slots

• head
• body
• footer

CSS Properties

• --canary-content-max-widthMax width

CSS Parts

• container

canary-trigger-searchbar

source

Imports

• canary-media-query

Attributes

• shortcutTriggerShortcut

CSS Properties

• --canary-trigger-searchbar-max-widthMax width
• --canary-trigger-searchbar-heightHeight

CSS Parts

• button
• icon
• text
• kbd

canary-trigger-logo

source

Imports

• canary-tooltip

Attributes

• textstring

canary-input

source

Imports

• canary-loading-spinner

Slots

• before
• action-search
• action-ask
• loading

Attributes

• autofocusboolean
• placeholderstring

CSS Parts

• container
• input

canary-search

source

Slots

• head
• body

CSS Parts

• container

canary-search-results

source

Imports

• canary-error
• canary-search-match

CSS Parts

• container
• match-group
• match-item

canary-search-match

source

Imports

• canary-search-match-webpage

Attributes

• matchSearchResult

CSS Parts

• match-group
• match-item

canary-search-match-base

source

Imports

• canary-modal

Slots

• content-before
• url
• title-icon
• title
• title-badge
• excerpt
• sub-results

Attributes

• urlstring

CSS Parts

• container

canary-search-match-webpage

source

Imports

• canary-search-match-base
• canary-url-paths
• canary-icon-tree
• canary-snippet-title
• canary-snippet-excerpt

Attributes

• matchSearchResult

canary-search-match-openapi

source

Imports

• canary-search-match-base

Attributes

• matchSearchResult

canary-search-match-github-issue

source

Imports

• canary-search-match-base
• canary-icon-tree
• canary-badge
• canary-snippet-title
• canary-snippet-excerpt
• canary-modal

Attributes

• matchSearchResult

canary-search-match-github-discussion

source

Imports

• canary-search-match-base
• canary-icon-tree
• canary-badge
• canary-snippet-title
• canary-snippet-excerpt
• canary-modal

Attributes

• matchSearchResult

canary-search-suggestions

source

canary-search-empty

source

canary-ask

source

Imports

• canary-mode-tabs

Slots

• body

CSS Parts

• container

canary-ask-results

source

Imports

• canary-markdown
• canary-ask-response

canary-tooltip

source

Slots

• Default

Attributes

• textstring
• placementPlacement

canary-footer

source

canary-media-query

source

Attributes

• querystring

canary-mode-tabs

source

canary-mode-breadcrumb

source

Attributes

• textstring

canary-filter-tabs-glob

source

Attributes

• tabsTabDefinitions

CSS Parts

• container
• tab
• active
• inactive

canary-filter-tags

source

Attributes

• tagsstring[]
• url-syncTagUrlSyncDefinition | undefined
• local-storage-keystring | undefined