docs_vue2/one/docs/getting-started/index.md
2022-05-26 01:58:05 +08:00

3.0 KiB
Raw Blame History

起步

:::tip 为了使 VEUI 在你的项目中运行,请按下述步骤完成所有安装及配置。 :::

安装

使用 Vue CLI 创建项目以后,在项目根目录下运行:

npm i --save veui veui-theme-dls
npm i --save-dev less less-loader veui-loader babel-plugin-veui babel-plugin-lodash

配置

Babel 插件

将项目根目录中生成的 babel.config.js 修改为:

module.exports = {
  presets: [
    '@vue/cli-plugin-babel/preset'
  ],
  plugins: [
    'veui',
    'lodash'
  ]
}

关于 babel-plugin-veui 的更详细信息请移步这里

Vue CLI 配置

对于需要引入默认主题包 veui-theme-dls 的项目,我们需要在项目根目录下的 vue.config.js 中进行如下配置:

const veuiLoaderOptions = require('veui-theme-dls/veui-loader-options')

module.exports = {
  css: {
    loaderOptions: {
      less: {
        lessOptions: {
          javascriptEnabled: true
        }
      }
    }
  },
  transpileDependencies: ['veui'],
  chainWebpack (config) {
    config.module
      .rule('veui')
      .test(/\.vue$/)
      .pre()
      .use('veui-loader')
      .loader('veui-loader')
      .tap(() => veuiLoaderOptions)
  }
}

想了解配置 veui-loader 的更多细节,请移步这里

+++为什么要配置这些选项? VEUI 采取了样式主题与组件代码分离的开发、发布方式。组件代码对样式代码没有显式的依赖,所以需要使用 veui-loader 配置关联的主题包。

同时由于 Less 3+ 不再默认开启内联 JavaScript 解析,而 veui-theme-dls 依赖了这一功能,所以我们需要手动开启配置项。

另外,由于我们采用将 VEUI 及其依赖与项目一起打包的策略,需要手动指定相关的依赖包进行转译。 +++

全局样式

在使用默认主题 veui-theme-dls 时,需要先全局引入基础样式以及,包括样式的 normalize 及一些基本元素的样式。

从 JavaScript 引入:

import 'veui-theme-dls/common.less'

数字字体

默认主题 veui-theme-dls 自带一款展示型的数字字体“Baidu Number”但由于启用后会自动加载 Web 字体,故默认未包含在全局样式中。需要使用时请在项目中手动引入:

import 'veui-theme-dls/typography.less'

引入后可在 CSS 中使用名为 "Baidu Number" 的字体。同时在动态数字场景下,往往需要数字等宽以保证布局的相对稳定,此时可以设置 font-variant-numeric: tabular-nums 以开启字体中的对应 Open Type 功能。

.heading-numbers {
  font-family: "Baidu Number", sans-serif;
  font-variant-numeric: tabular-nums; /* 等宽场景 */
}

:::warning 请确保 veui-theme-dls/common.lessveui-theme-dls/typography.less 只被引入一次,在多个组件中重复引入将导致内容重复输出。 :::