# Naive UI > A Vue 3 component library. Fairly complete, theme customizable, uses TypeScript, fast. Each link below is the Markdown version of a page of the docs site (https://www.naiveui.com). Component pages include the API and the full source of every demo. All pages in one file: https://www.naiveui.com/llms-full.txt. In Chinese: https://www.naiveui.com/zh-CN/llms.txt. ## Introduction - [Naive UI](https://www.naiveui.com/en-US/docs/introduction.md): Naive UI is a Vue 3 component library. ## Getting Started - [Installation](https://www.naiveui.com/en-US/docs/installation.md): Use npm to install. - [Usage in SFC](https://www.naiveui.com/en-US/docs/usage-sfc.md): If you want to use the Single File Component(SFC) style, you can directly import components from Naive UI or install it globally to a Vue app. - [Using UMD](https://www.naiveui.com/en-US/docs/umd.md): After version `2.30.3`, you can use UMD version of naive. - [Configuring Fonts](https://www.naiveui.com/en-US/docs/fonts.md): Naive UI works with [vfonts](https://github.com/07akioni/vfonts). You can use fonts from `vfonts` easily which includes general fonts and monospace fonts. - [Import on Demand (Tree Shaking)](https://www.naiveui.com/en-US/docs/import-on-demand.md): Naive UI supports tree shaking for components, locales and themes. - [Supported Platforms](https://www.naiveui.com/en-US/docs/supported-platforms.md): IE is not supported. - [Common Issues](https://www.naiveui.com/en-US/docs/common-issues.md): If you are not using `v-model:xxx` with `on-update:xxx` on the same component, there is no difference between `@update:xxx` and `on-update:xxx` when used in templates. - [Controlled manner & uncontrolled manner](https://www.naiveui.com/en-US/docs/controlled-uncontrolled.md): A component's manner can be controlled or uncontrolled. Uncontrolled manner means you only listen to its change but not control its value. Controlled manner means you control the component's value. - [LLMs](https://www.naiveui.com/en-US/docs/llms.md): The docs are also published as Markdown for LLMs and agents, following [llms.txt](https://llmstxt.org). ## Guides - [JSX & TSX](https://www.naiveui.com/en-US/docs/jsx.md): For how to enable JSX & TSX, please look at your toolchain's docs. - [Server-Sider Rendering](https://www.naiveui.com/en-US/docs/ssr.md): Since naive-ui is using CSS in JS, in SSR mode it needs some extra configuration. - [Nuxt.js](https://www.naiveui.com/en-US/docs/nuxtjs.md): This document pertains to SSR (Server-Side Rendering). Please familiarize yourself with the [SSR Caveats](https://www.naiveui.com/en-US/docs/ssr.md#Caveat) before proceeding. - [Vitepress](https://www.naiveui.com/en-US/docs/vitepress.md): This document pertains to SSR (Server-Side Rendering). Please familiarize yourself with the [SSR Caveats](https://www.naiveui.com/en-US/docs/ssr.md#Caveat) before proceeding. - [Vite SSG/SSE](https://www.naiveui.com/en-US/docs/vite-ssge.md): This document pertains to SSR (Server-Side Rendering). Please familiarize yourself with the [SSR Caveats](https://www.naiveui.com/en-US/docs/ssr.md#Caveat) before proceeding. - [Customizing theme](https://www.naiveui.com/en-US/docs/customize-theme.md): Naive-ui provides `n-config-provider` to customize the theme. - [Internationalization](https://www.naiveui.com/en-US/docs/i18n.md): Naive-ui provides `n-config-provider` to customize the internationalization. By default, all components are in English. - [Create Themed Component](https://www.naiveui.com/en-US/docs/theme.md): You may not want to use only the provided components and want to write themed components. - [Potential Style Conflict](https://www.naiveui.com/en-US/docs/style-conflict.md): Sometimes you want to control where the style element should be inserted. - [Third-Party Libraries](https://www.naiveui.com/en-US/docs/community.md): Naive UI is a high-quality Vue component library of unified design specifications. We prefer to provide only UI components with a unified specification and visual presentation. So we recommend the following great resources from the community that complement Naive UI. ## Common Components - [Avatar](https://www.naiveui.com/en-US/components/avatar.md): On the Internet, nobody knows you're a dog. - [Button](https://www.naiveui.com/en-US/components/button.md): Button is used to trigger some actions. - [Card](https://www.naiveui.com/en-US/components/card.md): Just put something in it. - [Carousel](https://www.naiveui.com/en-US/components/carousel.md): It's usually used to display good news. - [Collapse](https://www.naiveui.com/en-US/components/collapse.md): I saw it appears in many side control panels. - [Divider](https://www.naiveui.com/en-US/components/divider.md): Divide something. - [Dropdown](https://www.naiveui.com/en-US/components/dropdown.md): When you have some functions to trigger. - [Ellipsis](https://www.naiveui.com/en-US/components/ellipsis.md): Complexity has to live somewhere. - [Gradient Text](https://www.naiveui.com/en-US/components/gradient-text.md): It doesn't seem very useful... In fact it isn't. - [Icon](https://www.naiveui.com/en-US/components/icon.md): It is recommend to use [xicons](https://www.xicons.org) as your icon library. - [PageHeader](https://www.naiveui.com/en-US/components/page-header.md): I hope this component has all the slots you need! - [Tag](https://www.naiveui.com/en-US/components/tag.md): Tags are great for showing attributes; and sometimes toggle options. - [Typography](https://www.naiveui.com/en-US/components/typography.md): Naive UI provides some HTML text styling. - [Watermark](https://www.naiveui.com/en-US/components/watermark.md): Watermark. - [Float Button](https://www.naiveui.com/en-US/components/float-button.md): Like `BackTop` but with more appearance level, more interaction. ## Data Input Components - [AutoComplete](https://www.naiveui.com/en-US/components/auto-complete.md): Offer a search hint or maybe guess some likely options? - [Cascader](https://www.naiveui.com/en-US/components/cascader.md): Cascader can be used to display and select tree structured data. - [Color Picker](https://www.naiveui.com/en-US/components/color-picker.md): Unlike the real world, these color values are discrete. - [Checkbox](https://www.naiveui.com/en-US/components/checkbox.md): Yo, yo, check it out. - [Date Picker](https://www.naiveui.com/en-US/components/date-picker.md): People have too many ideas on how to set the time. - [Dynamic Input](https://www.naiveui.com/en-US/components/dynamic-input.md): This component's name has been changed so many times. - [Dynamic Tags](https://www.naiveui.com/en-US/components/dynamic-tags.md): Turn tags to inputs and back again. - [Form](https://www.naiveui.com/en-US/components/form.md): The element to collect and validate data. - [Input](https://www.naiveui.com/en-US/components/input.md): Many years ago, inputs were just punched cards. - [Input Number](https://www.naiveui.com/en-US/components/input-number.md): If you just want a number, this is for you. - [Input OTP](https://www.naiveui.com/en-US/components/input-otp.md): InputOTP is used to enter one time password. - [Mention](https://www.naiveui.com/en-US/components/mention.md): A year ago, my product manager asked me if I could implement this feature. Back then, I recommended just using multiple selects as a workaround. - [Radio](https://www.naiveui.com/en-US/components/radio.md): When I was young, I loved listening to the radio, such as FM 106.8 or FM 92.1. - [Rate](https://www.naiveui.com/en-US/components/rate.md): Hint: If you are not very confident, think twice before changing the star's color. That can lead to a disaster. - [Select](https://www.naiveui.com/en-US/components/select.md): Select something! - [Slider](https://www.naiveui.com/en-US/components/slider.md): As far as I know, it is always used as a volume control. - [Switch](https://www.naiveui.com/en-US/components/switch.md): I have a Nintendo Switch, but don't have time to play it. This reminds me of my childhood when I played NDS... a happier time. - [Time Picker](https://www.naiveui.com/en-US/components/time-picker.md): Like a digital clock. - [Transfer](https://www.naiveui.com/en-US/components/transfer.md): A more efficient transfer. - [Tree Select](https://www.naiveui.com/en-US/components/tree-select.md): It's said that 99% of the people can't distinguish the `TreeSelect` component from the `Cascader` component. - [Upload](https://www.naiveui.com/en-US/components/upload.md): If latency didn't matter, I'd just fill trucks with hard disks. ## Data Display Components - [Calendar](https://www.naiveui.com/en-US/components/calendar.md): How time flies. - [Countdown](https://www.naiveui.com/en-US/components/countdown.md): A second is passed after a second has passed. - [Code](https://www.naiveui.com/en-US/components/code.md): The following code shows how to set hljs of Code. Importing highlight.js on demand is recommonded, because it can significantly reduce bundle size of your app. - [Data Table](https://www.naiveui.com/en-US/components/data-table.md): DataTable is used to displays rows of structured data. - [Descriptions](https://www.naiveui.com/en-US/components/descriptions.md): Display items of content easily. - [Empty](https://www.naiveui.com/en-US/components/empty.md): Empty. - [Equation](https://www.naiveui.com/en-US/components/equation.md): No one will think of that a component library should have this component. However a friend of me need this. - [Image](https://www.naiveui.com/en-US/components/image.md): Preview it. - [List](https://www.naiveui.com/en-US/components/list.md): It is hard to make it looks elegant. However things should be done. - [Log](https://www.naiveui.com/en-US/components/log.md): If you have some logs to show, use log. - [Number Animation](https://www.naiveui.com/en-US/components/number-animation.md): Tween the number. - [QR Code](https://www.naiveui.com/en-US/components/qr-code.md): It is always only valid for a short time. - [Statistic](https://www.naiveui.com/en-US/components/statistic.md): As simple as it looks. - [Table](https://www.naiveui.com/en-US/components/table.md): If you only want to render some basic tables, use it. If you want to render structured data, see [Data Table](https://www.naiveui.com/en-US/components/data-table.md). - [Thing](https://www.naiveui.com/en-US/components/thing.md): When you want to describe a thing, use thing. If you find it doesn't fit you demand, write one by yourself. - [Time](https://www.naiveui.com/en-US/components/time.md): Time provide some basic formation for time. - [Timeline](https://www.naiveui.com/en-US/components/timeline.md): The world is 2 dimensioned. One of them is time. The Other is event. - [Tree](https://www.naiveui.com/en-US/components/tree.md): To be honest, I'm not good at biology. I can figure out few kinds of trees. - [Infinite Scroll](https://www.naiveui.com/en-US/components/infinite-scroll.md): Scroll, scroll, scroll, scroll... - [Highlight](https://www.naiveui.com/en-US/components/highlight.md): If you've used a search engine, you should know what it is. - [Heatmap](https://www.naiveui.com/en-US/components/heatmap.md): Digital workers have their own wall to paint. ## Navigation Components - [Affix](https://www.naiveui.com/en-US/components/affix.md): Affix can make content stick to fixed places when scrolling. It's similar to `position: sticky` but can do more things. - [Anchor](https://www.naiveui.com/en-US/components/anchor.md): Tell you where you are. - [Back Top](https://www.naiveui.com/en-US/components/back-top.md): It helps you back to where you were. However, time never goes back. - [Breadcrumb](https://www.naiveui.com/en-US/components/breadcrumb.md): It doesn't look like what it calls. - [Loading Bar](https://www.naiveui.com/en-US/components/loading-bar.md): A kind of good placebo for anxiety. - [Menu](https://www.naiveui.com/en-US/components/menu.md): No Food. - [Pagination](https://www.naiveui.com/en-US/components/pagination.md): Long data's friend. - [Steps](https://www.naiveui.com/en-US/components/steps.md): 1, 2, 3... done! - [Tabs](https://www.naiveui.com/en-US/components/tabs.md): Switch contents in same area. ## Feedback Components - [Alert](https://www.naiveui.com/en-US/components/alert.md): According to my experience, the most frequent usage of it may be requesting for disabling AdBlocks. - [Badge](https://www.naiveui.com/en-US/components/badge.md): I bet you have seen it and know how it should be applied. - [Dialog](https://www.naiveui.com/en-US/components/dialog.md): Before taking action, please confirm. - [Drawer](https://www.naiveui.com/en-US/components/drawer.md): I think it is similar with modal, with a bit difference on placement. - [Marquee](https://www.naiveui.com/en-US/components/marquee.md): A trivia: There's a deprecated HTML Element called `marquee`. - [Message](https://www.naiveui.com/en-US/components/message.md): Oracle from the top(always) of the browser. - [Modal](https://www.naiveui.com/en-US/components/modal.md): It just pops and shows you something. - [Notification](https://www.naiveui.com/en-US/components/notification.md): If something is to be telled to somebody. - [Popconfirm](https://www.naiveui.com/en-US/components/popconfirm.md): A confirm, poped. - [Popover](https://www.naiveui.com/en-US/components/popover.md): Pop some hidden message around content. There isn't much builtin styles in popover. It's more up to you to fill the content. - [Popselect](https://www.naiveui.com/en-US/components/popselect.md): If you want select some options but don't want a picker, you can use popselect instead. - [Progress](https://www.naiveui.com/en-US/components/progress.md): I have no words to say but there still should be a placeholder to make layout looks spread. - [Result](https://www.naiveui.com/en-US/components/result.md): Result is for showing result. - [Skeleton](https://www.naiveui.com/en-US/components/skeleton.md): A twinkle placeholder. - [Spin](https://www.naiveui.com/en-US/components/spin.md): It could've been called `loading`, but why is it called `spin`? Because there is another internal component with less props already named `loading`. - [Tooltip](https://www.naiveui.com/en-US/components/tooltip.md): It walks like a popover, quacks like a popover but looks a bit different from popover. ## Layout Components - [Flex](https://www.naiveui.com/en-US/components/flex.md): Available since `2.37.0`. - [Layout](https://www.naiveui.com/en-US/components/layout.md): Layout is for layout. - [Legacy Grid](https://www.naiveui.com/en-US/components/legacy-grid.md): A basic grid system. - [Grid](https://www.naiveui.com/en-US/components/grid.md): Based on CSS Grid. Responsive. Keep away from IE. - [Space](https://www.naiveui.com/en-US/components/space.md): A great invention (which is not invented by me). - [Split](https://www.naiveui.com/en-US/components/split.md): The flexible layout tool provides the possibility of customizing the interface layout. ## Utility Components - [Collapse Transition](https://www.naiveui.com/en-US/components/collapse-transition.md): A collapse item without any form of encapsulation. - [Discrete API(v2.29.0)](https://www.naiveui.com/en-US/components/discrete.md): If you want to use `useDialog`, `useMessage`, `useNotification`, `useLoadingBar`, `useModal` outside `setup`, you can use `createDiscreteApi` to create corresponding API. - [Scrollbar](https://www.naiveui.com/en-US/components/scrollbar.md): It looks better but I'm sure it's not as reliable as native scrollbar. - [Virtual List](https://www.naiveui.com/en-US/components/virtual-list.md): When it comes to virtual lists, it can feel like a list is infinitely long, but in reality it is just secretly hiding the invisible elements. ## Config Components - [Config Provider](https://www.naiveui.com/en-US/components/config-provider.md): Config Provider is used to set global theme, set global language and set namespace for components (detached parts). - [Element](https://www.naiveui.com/en-US/components/element.md): Element has many theme variables provided by Naive UI. - [Global Style](https://www.naiveui.com/en-US/components/global-style.md): For the following reasons, you may need to set some styles on `document.body` ## Deprecated Components - [Legacy Transfer](https://www.naiveui.com/en-US/components/legacy-transfer.md): Left, right, right, left... I'm a simple man, and I can play this all day. ## Optional - [CHANGELOG](https://www.naiveui.com/en-US/docs/changelog.md): `2026-08-21`