naive-ui
Version:
A Vue 3 Component Library. Fairly Complete, Theme Customizable, Uses TypeScript, Fast
1,259 lines (1,258 loc) • 720 kB
JSON
{
"$schema": "https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json",
"framework": "vue",
"name": "naive-ui",
"version": "2.40.1",
"js-types-syntax": "typescript",
"contributions": {
"html": {
"vue-components": [
{
"name": "NAffix",
"description": "Affix can make content stick to fixed places when scrolling. It's similar to `position: sticky` but can do more things.",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/affix",
"source": {
"symbol": "NAffix"
},
"slots": [],
"attributes": [],
"props": [
{
"name": "listen-to",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/affix",
"type": "string | HTMLElement | Document | Window | (() => HTMLElement)",
"description": "The scrolling element to listen scrolling.",
"default": "document"
},
{
"name": "top",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/affix",
"type": "number",
"description": "The css top property after trigger top affix. (if not set, use `trigger-top` prop)",
"default": "undefined"
},
{
"name": "bottom",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/affix",
"type": "number",
"description": "The css bottom property after trigger bottom affix. (if not set, use `trigger-bottom` prop)",
"default": "undefined"
},
{
"name": "trigger-top",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/affix",
"type": "number",
"description": "The distance px to top of target to trigger top affix. (if not set, use `top` prop)",
"default": "undefined"
},
{
"name": "trigger-bottom",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/affix",
"type": "number",
"description": "The distance px to bottom of target to trigger bottom affix. (if not set, use `bottom` prop)",
"default": "undefined"
},
{
"name": "position",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/affix",
"type": "'fixed' | 'absolute'",
"description": "CSS position of the affix.",
"default": "'fixed'"
},
{
"name": "offset-top",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/affix",
"type": "number"
},
{
"name": "offset-bottom",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/affix",
"type": "number"
},
{
"name": "target",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/affix",
"type": "Function"
}
],
"js": {
"events": []
}
},
{
"name": "NAlert",
"description": "According to my experience, the most frequent usage of it may be requesting for disabling AdBlocks.",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/alert",
"source": {
"symbol": "NAlert"
},
"slots": [
{
"name": "default",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/alert",
"description": "The content of the alert."
},
{
"name": "header",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/alert",
"description": "The content placed in the alert header."
},
{
"name": "icon",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/alert",
"description": "Icon displayed in the alert."
}
],
"attributes": [],
"props": [
{
"name": "title",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/alert",
"type": "string",
"description": "Title of the alert.",
"default": "undefined"
},
{
"name": "show-icon",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/alert",
"type": "boolean",
"description": "Whether to show the icon of alert.",
"default": "true"
},
{
"name": "type",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/alert",
"type": "'default' | 'info' | 'success' | 'warning' | 'error'",
"description": "Alert type.",
"default": "'default'"
},
{
"name": "bordered",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/alert",
"type": "boolean",
"description": "Whether the alert can show border.",
"default": "true",
"description-sections": {
"since": "2.32.2"
}
},
{
"name": "closable",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/alert",
"type": "boolean",
"description": "Whether the alert can be closed.",
"default": "false"
}
],
"js": {
"events": [
{
"name": "close",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/alert",
"type": "() => boolean | Promise<boolean> | any",
"description": "The callback function executed when the close icon is clicked.",
"default": "() => true"
},
{
"name": "after-leave",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/alert",
"type": "Function",
"description": "Callback function executed when the alert disappears.",
"default": "undefined"
},
{
"name": "after-hide",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/alert"
}
]
}
},
{
"name": "NAnchor",
"description": "<!--single-column-->\n\nTell you where you are.",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/anchor",
"source": {
"symbol": "NAnchor"
},
"slots": [],
"attributes": [],
"props": [
{
"name": "affix",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/anchor",
"type": "boolean",
"description": "If it works like an affix. If set to `true`, it will receive props from [affix](affix#Affix-Props).",
"default": "false"
},
{
"name": "listen-to",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/anchor",
"type": "string | object | Function"
},
{
"name": "top",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/anchor",
"type": "number"
},
{
"name": "bottom",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/anchor",
"type": "number"
},
{
"name": "trigger-top",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/anchor",
"type": "number"
},
{
"name": "trigger-bottom",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/anchor",
"type": "number"
},
{
"name": "position",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/anchor",
"type": "string"
},
{
"name": "offset-top",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/anchor",
"type": "number"
},
{
"name": "offset-bottom",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/anchor",
"type": "number"
},
{
"name": "target",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/anchor",
"type": "Function"
},
{
"name": "type",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/anchor",
"type": "'rail' | 'block'",
"description": "The type to use.",
"default": "'rail'"
},
{
"name": "show-rail",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/anchor",
"type": "boolean",
"description": "Whether to show the sider rail.",
"default": "true"
},
{
"name": "show-background",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/anchor",
"type": "boolean",
"description": "Whether to show background of links.",
"default": "true"
},
{
"name": "bound",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/anchor",
"type": "number",
"description": "The height of the border when scrolling.",
"default": "12"
},
{
"name": "ignore-gap",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/anchor",
"type": "boolean",
"description": "If set to `true`, it will be displayed on the exact href.",
"default": "false"
},
{
"name": "offset-target",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/anchor",
"type": "string | HTMLElement | Window | Document | (() => HTMLElement)",
"description": "The element or selector used to calc offset of link elements. If you are not scrolling the entire document but only a part of it, you may need to set this.",
"default": "document"
}
],
"js": {
"events": []
}
},
{
"name": "NAnchorLink",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/anchor",
"source": {
"symbol": "NAnchorLink"
},
"slots": [],
"attributes": [],
"props": [
{
"name": "title",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/anchor",
"type": "stirng",
"description": "The content of link",
"default": "undefined"
},
{
"name": "href",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/anchor",
"type": "string",
"description": "The target of link",
"default": "undefined"
}
],
"js": {
"events": []
}
},
{
"name": "NAutoComplete",
"description": "Offer a search hint or maybe guess some likely options?",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/auto-complete",
"source": {
"symbol": "NAutoComplete"
},
"slots": [
{
"name": "default",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/auto-complete",
"type": "{ handleInput: (value: string) => void, handleFocus: function, handleBlur: function, value: string, theme: string | null }",
"description": "Custom input elements, supplied by the user."
},
{
"name": "empty",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/auto-complete",
"description": "Menu's content to show when there's no option.",
"description-sections": {
"since": "2.37.1"
}
},
{
"name": "prefix",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/auto-complete",
"description": "Input's prefix content."
},
{
"name": "suffix",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/auto-complete",
"description": "Input's suffix content."
}
],
"attributes": [],
"props": [
{
"name": "to",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/auto-complete",
"type": "string | HTMLElement | false",
"description": "Container node of the menu. `false` will keep it not detached.",
"default": "body"
},
{
"name": "menu-props",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/auto-complete",
"type": "HTMLAttributes",
"description": "The menu's dom props.",
"default": "undefined",
"description-sections": {
"since": "2.32.2"
}
},
{
"name": "append",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/auto-complete",
"type": "boolean",
"description": "Whether to append content to input.",
"default": "false",
"description-sections": {
"since": "2.38.0"
}
},
{
"name": "bordered",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/auto-complete",
"type": "boolean"
},
{
"name": "clearable",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/auto-complete",
"type": "boolean",
"description": "Whether autocomplete is clearable.",
"default": "false"
},
{
"name": "default-value",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/auto-complete",
"type": "string",
"description": "Default value of autocomplete.",
"default": "null"
},
{
"name": "loading",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/auto-complete",
"type": "boolean",
"description": "Whether to show a loading status.",
"default": "false"
},
{
"name": "disabled",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/auto-complete",
"type": "boolean",
"description": "Whether the autocomplete is disabled.",
"default": "false"
},
{
"name": "placeholder",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/auto-complete",
"type": "string",
"description": "Autocomplete's placeholder.",
"default": "'Please Input'"
},
{
"name": "placement",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/auto-complete",
"type": "'top-start' | 'top' | 'top-end' | 'right-start' | 'right' | 'right-end' | 'bottom-start' | 'bottom' | 'bottom-end' | 'left-start' | 'left' | 'left-end'",
"description": "Autocomplete's placement.",
"default": "'bottom-start'",
"description-sections": {
"since": "2.25.0"
}
},
{
"name": "value",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/auto-complete",
"type": "string",
"description": "Input of autocomplete.",
"default": "undefined"
},
{
"name": "blur-after-select",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/auto-complete",
"type": "boolean",
"description": "Whether to blur after selection.",
"default": "false"
},
{
"name": "clear-after-select",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/auto-complete",
"type": "boolean",
"description": "Whether to clear after selection.",
"default": "false"
},
{
"name": "get-show",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/auto-complete",
"type": "(value: string) => boolean",
"description": "Use the input to determine whether to show options on focus.",
"default": "undefined"
},
{
"name": "show-empty",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/auto-complete",
"type": "boolean",
"description": "Whether to show menu if there's no option.",
"default": "false",
"description-sections": {
"since": "2.37.1"
}
},
{
"name": "input-props",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/auto-complete",
"type": "InputHTMLAttributes",
"description": "The attributes of input element in autocomplete.",
"default": "undefined"
},
{
"name": "render-option",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/auto-complete",
"type": "(info: { node: VNode, option: SelectOption | SelectGroupOption, selected: boolean }) => VNodeChild",
"description": "Render function for each option.",
"default": "undefined",
"description-sections": {
"since": "2.24.0"
}
},
{
"name": "render-label",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/auto-complete",
"type": "(option: SelectOption | SelectGroupOption, selected: boolean) => VNodeChild",
"description": "Render function for each option label.",
"default": "undefined",
"description-sections": {
"since": "2.24.0"
}
},
{
"name": "size",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/auto-complete",
"type": "'small' | 'medium' | 'large'",
"description": "Autocomplete size.",
"default": "'medium'"
},
{
"name": "options",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/auto-complete",
"type": "Array<string | AutoCompleteOption | AutoCompleteGroupOption>",
"description": "Options to autocomplete from.",
"default": "[]"
},
{
"name": "z-index",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/auto-complete",
"type": "number"
},
{
"name": "status",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/auto-complete",
"type": "'success' | 'warning' | 'error'",
"description": "Validation status.",
"default": "undefined",
"description-sections": {
"since": "2.27.0"
}
}
],
"js": {
"events": [
{
"name": "update-value",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/auto-complete"
},
{
"name": "update-value",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/auto-complete"
},
{
"name": "select",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/auto-complete",
"type": "(value: string) => void",
"description": "On select callback function.",
"default": "undefined"
},
{
"name": "blur",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/auto-complete",
"type": "(event: FocusEvent) => void",
"description": "On blur callback function.",
"default": "undefined"
},
{
"name": "focus",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/auto-complete",
"type": "(event: FocusEvent) => void",
"description": "On focus callback function.",
"default": "undefined"
},
{
"name": "input",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/auto-complete"
},
{
"name": "update:value",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/auto-complete",
"type": "(value: string | null) => void",
"description": "On update callback function.",
"default": "undefined"
}
]
}
},
{
"name": "NAvatar",
"description": "On the Internet, nobody knows you're a dog.",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/avatar",
"source": {
"symbol": "NAvatar"
},
"slots": [
{
"name": "default",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/avatar",
"description": "The content of the avatar."
},
{
"name": "fallback",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/avatar",
"description": "Content if avatar load fails.",
"description-sections": {
"since": "2.33.4"
}
},
{
"name": "placeholder",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/avatar",
"description": "Placeholder shown when image is not loaded.",
"description-sections": {
"since": "2.31.0"
}
}
],
"attributes": [],
"props": [
{
"name": "size",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/avatar",
"type": "'small' | 'medium' | 'large' | number",
"description": "Avatar's size.",
"default": "'medium'"
},
{
"name": "src",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/avatar",
"type": "string",
"description": "Avatar's image source.",
"default": "undefined"
},
{
"name": "circle",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/avatar",
"type": "boolean"
},
{
"name": "object-fit",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/avatar",
"type": "'fill' | 'contain' | 'cover' | 'none' | 'scale-down'",
"description": "Object-fit type of the image in the container.",
"default": "'fill'"
},
{
"name": "round",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/avatar",
"type": "boolean",
"description": "Whether to display a rounded avatar.",
"default": "false"
},
{
"name": "bordered",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/avatar",
"type": "boolean",
"description": "Whether to display a avatar with border.",
"default": "false"
},
{
"name": "fallback-src",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/avatar",
"type": "string",
"description": "Image URL to show when avatar fails to load.",
"default": "undefined"
},
{
"name": "intersection-observer-options",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/avatar",
"type": "{ root?: Element | Document | string | null, rootMargin?: string, threshold?: number | number[]; }",
"description": "Intersection observer's config to be applied when `lazy=true`.",
"default": "undefined",
"description-sections": {
"since": "2.31.0"
}
},
{
"name": "lazy",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/avatar",
"type": "boolean",
"description": "Load image after it enters viewport. When used alone, it will be assigned the property value of [HTMLImageElement.loading](https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/loading). Alternatively, it can be used in conjunction with the `intersection-observer-options` configuration to achieve lazy loading.",
"default": "false",
"description-sections": {
"since": "2.31.0"
}
},
{
"name": "render-placeholder",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/avatar",
"type": "() => VNodeChild",
"description": "Render function of placeholder.",
"default": "undefined",
"description-sections": {
"since": "2.33.4"
}
},
{
"name": "render-fallback",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/avatar",
"type": "() => VNodeChild",
"description": "Render function of fallback content.",
"default": "undefined",
"description-sections": {
"since": "2.33.4"
}
},
{
"name": "img-props",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/avatar",
"type": "ImgHTMLAttributes",
"description": "The props of the img element inside the component.",
"default": "undefined",
"description-sections": {
"since": "2.34.0"
}
},
{
"name": "color",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/avatar",
"type": "string",
"description": "The background color of the avatar.",
"default": "undefined"
}
],
"js": {
"events": [
{
"name": "error",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/avatar",
"type": "(e: Event) => void",
"description": "Callback executed when the avatar image fails to load.",
"default": "undefined"
},
{
"name": "load",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/avatar"
}
]
}
},
{
"name": "NAvatarGroup",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/avatar",
"source": {
"symbol": "NAvatarGroup"
},
"slots": [
{
"name": "avatar",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/avatar",
"type": "{ option: { src: string } }",
"description": "Avatar of the avatar group."
},
{
"name": "default",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/avatar",
"description": "The content of the avatar group."
},
{
"name": "rest",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/avatar",
"type": "{ options: Array<{ src: string }>, rest: number }",
"description": "Overflow indicator of the avatar group."
}
],
"attributes": [],
"props": [
{
"name": "max",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/avatar",
"type": "number",
"description": "Max avatar count in the group.",
"default": "undefined"
},
{
"name": "max-style",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/avatar",
"type": "Object | string",
"description": "The style of the overflow placeholder.",
"default": "undefined"
},
{
"name": "options",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/avatar",
"type": "Array<AvatarOption>",
"description": "Avatar group options.",
"default": "[]"
},
{
"name": "vertical",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/avatar",
"type": "boolean",
"description": "Whether display a vertical avatar group.",
"default": "false"
},
{
"name": "expand-on-hover",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/avatar",
"type": "boolean",
"description": "Expand on hover.",
"default": "false",
"description-sections": {
"since": "2.37.0"
}
},
{
"name": "size",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/avatar",
"type": "string | number"
}
],
"js": {
"events": []
}
},
{
"name": "NBackTop",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/back-top",
"source": {
"symbol": "NBackTop"
},
"slots": [],
"attributes": [],
"props": [
{
"name": "show",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/back-top",
"type": "boolean",
"description": "Whether to show BackTop",
"default": "undefined"
},
{
"name": "right",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/back-top",
"type": "number | string",
"description": "The width of BackTop from the right side of the page",
"default": "40"
},
{
"name": "bottom",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/back-top",
"type": "number | string",
"description": "The height of BackTop from the bottom of the page",
"default": "40"
},
{
"name": "to",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/back-top",
"type": "string | HTMLElement",
"description": "Container node to show BackTop",
"default": "'body'"
},
{
"name": "visibility-height",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/back-top",
"type": "number",
"description": "BackTop's trigger scroll top.",
"default": "180"
},
{
"name": "listen-to",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/back-top",
"type": "string | HTMLElement",
"description": "The element to be listened to scroll event. If it is `undefined` back top will listen to the nearest scrollable parent.",
"default": "undefined"
},
{
"name": "target",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/back-top",
"type": "Function"
}
],
"js": {
"events": [
{
"name": "update-show",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/back-top"
},
{
"name": "show",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/back-top"
},
{
"name": "hide",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/back-top"
},
{
"name": "update:show",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/back-top",
"type": "(value: boolean) => void",
"description": "Callback is triggered when back-top display changes.",
"default": "undefined"
}
]
}
},
{
"name": "NBadge",
"description": "I bet you have seen it and know how it should be applied.",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/badge",
"source": {
"symbol": "NBadge"
},
"slots": [
{
"name": "default",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/badge",
"description": "Badge's content."
}
],
"attributes": [],
"props": [
{
"name": "value",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/badge",
"type": "string | number",
"description": "Badge's value.",
"default": "undefined"
},
{
"name": "max",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/badge",
"type": "number",
"description": "The maximum number of the badge when its value overflows.",
"default": "undefined"
},
{
"name": "dot",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/badge",
"type": "boolean",
"description": "Show badge as dot.",
"default": "false"
},
{
"name": "type",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/badge",
"type": "'default' | 'success' | 'error' | 'warning' | 'info'",
"description": "Type of the badge.",
"default": "'default'"
},
{
"name": "show",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/badge",
"type": "boolean",
"description": "Whether the badge should be shown altogether.",
"default": "true"
},
{
"name": "show-zero",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/badge",
"type": "boolean",
"description": "Whether to display the badge, even if provided value equals 0.",
"default": "false"
},
{
"name": "processing",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/badge",
"type": "boolean",
"description": "Show processing status.",
"default": "false"
},
{
"name": "color",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/badge",
"type": "string",
"description": "Badge color.",
"default": "undefined"
},
{
"name": "offset",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/badge",
"type": "[string | number, string | number]",
"description": "Offset of the badge from the left and top of the default position.",
"default": "undefined",
"description-sections": {
"since": "2.34.3"
}
}
],
"js": {
"events": []
}
},
{
"name": "NBreadcrumb",
"description": "It doesn't look like what it calls.",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/breadcrumb",
"source": {
"symbol": "NBreadcrumb"
},
"slots": [
{
"name": "default",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/breadcrumb",
"description": "Breadcrumb default slot."
}
],
"attributes": [],
"props": [
{
"name": "separator",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/breadcrumb",
"type": "string",
"description": "Breadcrumb separator.",
"default": "'/'"
}
],
"js": {
"events": []
}
},
{
"name": "NBreadcrumbItem",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/breadcrumb",
"source": {
"symbol": "NBreadcrumbItem"
},
"slots": [],
"attributes": [],
"props": [
{
"name": "separator",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/breadcrumb",
"type": "string",
"description": "BreadcrumbItem separator.",
"default": "undefined"
},
{
"name": "href",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/breadcrumb",
"type": "string",
"description": "BreadcrumbItem link.",
"default": "undefined"
},
{
"name": "clickable",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/breadcrumb",
"type": "boolean",
"description": "Whether it's clickable.",
"default": "true",
"description-sections": {
"since": "2.30.0"
}
}
],
"js": {
"events": [
{
"name": "click",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/breadcrumb"
}
]
}
},
{
"name": "NButton",
"description": "Button is used to trigger some actions.",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/button",
"source": {
"symbol": "NButton"
},
"slots": [
{
"name": "default",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/button",
"description": "The default content of the button."
},
{
"name": "icon",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/button",
"description": "The icon of the button."
}
],
"attributes": [],
"props": [
{
"name": "color",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/button",
"type": "string",
"description": "Button color (support `#FFF`, `#FFFFFF`, `yellow`,`rgb(0, 0, 0)` formatted colors).",
"default": "undefined"
},
{
"name": "text-color",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/button",
"type": "string",
"description": "Button text color (support `#FFF`, `#FFFFFF`, `yellow`,`rgb(0, 0, 0)` formatted colors).",
"default": "undefined"
},
{
"name": "text",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/button",
"type": "boolean",
"description": "Whether to display as a text button.",
"default": "false"
},
{
"name": "block",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/button",
"type": "boolean",
"description": "Whether the button is displayed as block.",
"default": "false"
},
{
"name": "loading",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/button",
"type": "boolean",
"description": "Whether the button shows the loading status.",
"default": "false"
},
{
"name": "disabled",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/button",
"type": "boolean",
"description": "Whether the button is disabled.",
"default": "false"
},
{
"name": "circle",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/button",
"type": "boolean",
"description": "Whether the button is round.",
"default": "false"
},
{
"name": "size",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/button",
"type": "'tiny' | 'small' | 'medium' | 'large'",
"description": "Button size.",
"default": "'medium'"
},
{
"name": "ghost",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/button",
"type": "boolean",
"description": "Whether the button is ghost.",
"default": "false"
},
{
"name": "round",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/button",
"type": "boolean",
"description": "Whether the button shows rounded corners.",
"default": "false"
},
{
"name": "secondary",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/button",
"type": "boolean",
"description": "Whether the button is secondary button.",
"default": "false"
},
{
"name": "tertiary",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/button",
"type": "boolean",
"description": "Whether the button is tertiary button.",
"default": "false"
},
{
"name": "quaternary",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/button",
"type": "boolean",
"description": "Whether the button is quaternary button.",
"default": "false"
},
{
"name": "strong",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/button",
"type": "boolean",
"description": "Whether to use strong text in the button.",
"default": "false"
},
{
"name": "focusable",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/button",
"type": "boolean",
"description": "Whether the button is focusable.",
"default": "true"
},
{
"name": "keyboard",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/button",
"type": "boolean",
"description": "Whether is supports keyboard operation.",
"default": "true"
},
{
"name": "tag",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/button",
"type": "string",
"description": "What tag need the button be rendered as.",
"default": "'button'"
},
{
"name": "type",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/button",
"type": "'default' | 'tertiary' | 'primary' | 'success' | 'info' | 'warning' | 'error'",
"description": "Button type.",
"default": "'default'"
},
{
"name": "dashed",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/button",
"type": "boolean",
"description": "Whether the button's border is a dashed line.",
"default": "false"
},
{
"name": "render-icon",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/button",
"type": "() => VNodeChild",
"description": "Render function that renders button icon.",
"default": "undefined",
"description-sections": {
"since": "2.34.0"
}
},
{
"name": "icon-placement",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/button",
"type": "'left' | 'right'",
"description": "The position of the icon in the button.",
"default": "'left'"
},
{
"name": "attr-type",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/button",
"type": "'button' | 'submit' | 'reset'",
"description": "The `type` attribute of the button's DOM.",
"default": "'button'"
},
{
"name": "bordered",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/button",
"type": "boolean",
"description": "Whether the button shows the border.",
"default": "true"
},
{
"name": "native-focus-behavior",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/button",
"type": "boolean",
"description": "Whether to follow button's native focus behavior. Since safari's button can't be focused by click, naive-ui uses some tricks to make it focusable on safari. If you don't need the behavior or need the button to be draggable, you can enable the prop.",
"default": "Browser is not Safari",
"description-sections": {
"since": "2.28.3"
}
}
],
"js": {
"events": [
{
"name": "click",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/button"
}
]
}
},
{
"name": "NButtonGroup",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/button",
"source": {
"symbol": "NButtonGroup"
},
"slots": [
{
"name": "default",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/button",
"description": "The button group is filled by default."
}
],
"attributes": [],
"props": [
{
"name": "size",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/button",
"type": "'tiny' | 'small' | 'medium' | 'large'",
"description": "The buttons' size in button group. If set, the button's size prop inner group won't work.",
"default": "undefined"
},
{
"name": "vertical",
"doc-url": "https://www.naiveui.com/en-US/os-theme/components/button",
"type": "boolean",
"description": "Directions of buttons in the group.",
"default": "false"