<p align="center">
  <a href="https://ink.yunyoujun.cn" target="_blank" rel="noopener noreferrer"><img width="100" src="https://raw.githubusercontent.com/YunYouJun/element-theme-ink/master/docs/.vuepress/public/logo.png" alt="Element Theme Ink Logo"></a>
  <h1 align="center">Element-Theme-Ink</h1>
</p>

<p align="center">
  <a href="https://npmcharts.com/compare/element-theme-ink?minimal=true"><img src="https://img.shields.io/npm/dt/element-theme-ink.svg?style=for-the-badge" alt="Downloads"></a>
  <a href="https://www.npmjs.com/package/element-theme-ink"><img src="https://img.shields.io/npm/v/element-theme-ink.svg?style=for-the-badge" alt="Version"></a>
  <a href="https://www.npmjs.com/package/element-theme-ink"><img src="https://img.shields.io/npm/l/element-theme-ink.svg?style=for-the-badge" alt="License"></a>
  <a href="https://unpkg.com/element-theme-ink">
    <img src="https://img.badgesize.io/https://unpkg.com/element-theme-ink@latest/dist/index.css?compression=gzip&label=gzip%20size:%20CSS&style=for-the-badge">
  </a>
</p>

# Ink

[![docs](https://github.com/YunYouJun/element-theme-ink/actions/workflows/docs.yml/badge.svg)](https://github.com/YunYouJun/element-theme-ink/actions/workflows/docs.yml)

> A dead simple element theme.

- [Docs](https://ink.yunyoujun.cn/)
- [New Docs(rewrite with vuepress)](https://ink.elpsy.cn/)
- GitHub: [element-theme-ink](https://github.com/YunYouJun/element-theme-ink)
- npm: [element-theme-ink](https://www.npmjs.com/package/element-theme-ink)

Base on [element](https://github.com/ElemeFE/element) & [element-theme-chalk](https://github.com/ElementUI/theme-chalk)

## Installation

### Install Element

可参见 Element 官方文档 [安装](http://element-cn.eleme.io/#/zh-CN/component/installation)

```sh
npm install element-ui -S
```

### Install Theme

```shell
npm i element-theme-ink -S
# or
yarn add element-theme-ink
```

## Usage

ElementUI 使用方法参见[官网](http://element.eleme.io/)，各組件使用方法与 [Element 2.3](http://element.eleme.io/2.3/#/zh-CN/component/installation) 版本一致，本项目仅对主题样式进行定制。

提供多种方式导入

### Stylesheet

- JSDelivr: <https://cdn.jsdelivr.net/npm/element-theme-ink>

You can use unpkg directly.

```html
<link rel="stylesheet" href="https://unpkg.com/element-theme-ink" />
```

Or use css in node_modules.

```html
<link
  rel="stylesheet"
  href="path/to/node_modules/element-theme-ink/dist/index.css"
/>
```

### Import in Sass

```scss
@import "element-theme-ink";
```

### Import in Javascript

#### Fully import

```javascript
// main.js
import "element-theme-ink";
```

#### Import on demand

```javascript
import "element-theme-ink/dist/input.css";
import "element-theme-ink/dist/select.css";
// ...
```

#### Import Scss

```js
import "element-theme-ink/src/index.scss";
```

## Example

```js
// main.js
import Vue from "vue";
import ElementUI from "element-ui";
// 当您想要切换回 element 默认主题时，只需取消默认主题的注释，并注释 ink 主题的引入即可
// import 'element-ui/dist/theme-chalk/index.css'
import "element-theme-ink";
import App from "./App.vue";

Vue.use(ElementUI);

new Vue({
  el: "#app",
  render: (h) => h(App),
});
```
