快速上手

安装

  • 通过 Npm 或 Yarn 安装

NPM 安装

  1. # Vue2 项目
  2. npm i @nutui/nutui -S
  3. # Vue3 项目
  4. npm i @nutui/nutui@next -S

CDN 安装使用示例

可以通过 CDN 的方式引入, 可以在 jsdelivrunpkg 等公共 CDN 上获取到 NutUI。

  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta charset="UTF-8" />
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  6. <!-- 引入样式 -->
  7. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@nutui/nutui@next/dist/style.css" />
  8. <!-- 引入Vue -->
  9. <script src="https://cdn.jsdelivr.net/npm/vue@next"></script>
  10. <!-- 引入NutUI组件库 -->
  11. <script src="https://cdn.jsdelivr.net/npm/@nutui/nutui@next/dist/nutui.umd.js"></script>
  12. </head>
  13. <body>
  14. <div id="app">
  15. </div>
  16. <script>
  17. // 在 #app 标签下渲染一个按钮组件
  18. const app = Vue.createApp({
  19. template: `
  20. <nut-button type="primary">主要按钮</nut-button>
  21. <nut-button type="info">信息按钮</nut-button>
  22. <nut-button type="default">默认按钮</nut-button>
  23. <nut-button type="danger">危险按钮</nut-button>
  24. <nut-button type="warning">警告按钮</nut-button>
  25. <nut-button type="success">成功按钮</nut-button>
  26. `,
  27. });
  28. app.use(nutui);
  29. app.mount("#app");
  30. </script>
  31. </body>
  32. </html>

在页面中直接引入,将无法使用 主题定制 等功能。我们推荐使用 NPMYARN 方式安装,不推荐在页面中直接引入的用法

NPM 使用示例

  1. import { createApp } from "vue";
  2. import App from "./App.vue";
  3. import NutUI from "@nutui/nutui";
  4. import "@nutui/nutui/dist/style.css";
  5. createApp(App).use(NutUI).mount("#app");

注意:这种方式将会导入所有组件

推荐使用按需加载

  1. import { createApp } from "vue";
  2. import App from "./App.vue";
  3. import { Button, Cell, Icon } from "@nutui/nutui";
  4. import "@nutui/nutui/dist/style.css";
  5. createApp(App).use(Button).use(Cell).use(Icon).mount("#app");

注意事项

  • 使用:prop传递数据格式为 数字、布尔值或函数时,必须带:(兼容字符串类型除外),比如:
  1. <nut-switch :active="true" size="base"></nut-switch>

快速上手 - 图1