Can I Use

About 322 wordsAbout 1 min

2025-03-24

Overview

When writing articles, you can embed the support status of can-i-use WEB features across platforms.

This makes it easier to describe the support level of a particular WEB feature.

Configuration

This feature is not enabled by default. You can enable it in the configuration file.

.vuepress/config.ts
export default defineUserConfig({
  theme: plumeTheme({
    markdownP: {
      caniuse: true, 
    },
  })
})

In your Markdown file, use the following format:

@[caniuse](feature)

For convenience, the theme provides a tool: caniuse feature search, which can help generate the Markdown code.

Syntax

@[caniuse](feature)
@[caniuse{browser_versions}](feature)
@[caniuse embed_type](feature)
@[caniuse embed_type{browser_versions}](feature)

feature
Required. For correct values, refer to caniuse-embed.vercel.app
{browser_versions}
Optional. The support status of the feature across multiple browser versions.
Default value: {-2,1}
Format: {past,future} with values ranging from -5 ~ 3
- Less than 0 indicates support below the current browser version
- 0 indicates support at the current browser version
- Greater than 0 indicates support above the current browser version
embed_type
Optional. The type of resource embedding.
Type: 'embed' | 'image'
Default value: 'embed'

Caution

The use of image type is no longer recommended. Instead, use the embed type, as the theme has changed the embed implementation, offering faster loading, smaller size, and better interaction.