Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added .DS_Store
Binary file not shown.
16 changes: 0 additions & 16 deletions .babelrc

This file was deleted.

13 changes: 0 additions & 13 deletions .editorconfig

This file was deleted.

4 changes: 0 additions & 4 deletions .gitattributes

This file was deleted.

33 changes: 33 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@

name: ci

on:
push:
branches:
- main
pull_request:
branches:
- main

jobs:
ci:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: '16'
cache: yarn
- run: yarn install
- run: yarn lint
- run: yarn build
- name: Release Edge
if: |
github.event_name == 'push' &&
!contains(github.event.head_commit.message, '[skip-release]') &&
!contains(github.event.head_commit.message, 'chore') &&
!contains(github.event.head_commit.message, 'docs')
run: ./scripts/release-edge.sh
env:
NODE_AUTH_TOKEN: ${{secrets.NODE_AUTH_TOKEN}}
94 changes: 6 additions & 88 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,90 +1,8 @@
# Created by .ignore support plugin (hsz.mobi)
### Node template
# Logs
/logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage

# nyc test coverage
.nyc_output

# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/
jspm_packages/

# TypeScript v1 declaration files
typings/

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# dotenv environment variables file
.env

# parcel-bundler cache (https://parceljs.org/)
.cache

# next.js build output
.next

# nuxt.js build output
.nuxt

# Nuxt generate
dist

# vuepress build output
.vuepress/dist

# Serverless directories
.serverless

# IDE / Editor
.idea

# Service worker
sw.*

# macOS
.DS_Store

# Vim swap files
*.swp
node_modules
*.log*
**/.yarn/cache
**/.yarn/*state*
.nuxt
.output
11 changes: 0 additions & 11 deletions .npmignore

This file was deleted.

Binary file added .yarn/.DS_Store
Binary file not shown.
786 changes: 786 additions & 0 deletions .yarn/releases/yarn-3.2.1.cjs

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions .yarnrc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
nodeLinker: node-modules

yarnPath: .yarn/releases/yarn-3.2.1.cjs
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2020 Hom Wang
Copyright (c) 2021 Nuxt Project

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
125 changes: 28 additions & 97 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,106 +1,37 @@
# Nuxt-UI
# 🎨 Nuxt UI

**NuxtUI**是一个由 [TailwindCss CSS](https://tailwindcss.com/docs/installation)开发的`Vue`组件,宗旨是根据您的应用程序的独特设计进行定制。
Unified UI and Design Kit for the Nuxt.

新的框架,将由影子 Dom 开发... 该 UI 暂不开发新组件
## 📦 Packages

因为使用的是`TailwindCss CSS`,所以默认情况下使用的是它的类名,并且所有类名都是可配置的,从而使您可以完全自定义组件的外观。
<table>
<tbody>
<tr>
<td>
<h2><a href="./packages/ui">UI Components</a></h2>
<p>UI kit for examples and internal tooling UI. Demo on <a href="https://components.ui.nuxtjs.org">components.ui.nuxtjs.org</a></p>
</td>
<td>
<h2><a href="./packages/templates">UI Templates</a></h2>
<p>Pre-compiled html templates for internal pages. Demo on <a href="https://templates.ui.nuxtjs.org">templates.ui.nuxtjs.org</a></p>
</td>
<td>
<h2><a href="./packages/assets">UI Assets</a></h2>
<p> Shared assets and resources.</p>
</td>
</tr>
</tbody>
</table>

完全可以通过只需要配置一次就可以设置主题类了。

如有建议的地方还请大家反应出来,我希望通过 QQ 群: <a target="_blank" href="//shang.qq.com/wpa/qunwpaidkey=29f4417f6627cb73eb304b3833698cfe28ea196858df935010a186ba84db2288"><img border="0" src="//pub.idqqimg.com/wpa/images/group.png" alt="Vue/Nuxt.js" title="Vue/Nuxt.js"></a> 或 [Discordapp](https://discordapp.com/channels/473401852243869706/473511822893383691) 一起交流讨论
## 💻 Development

## 安装和使用
- Clone repository
- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable` (use `npm i -g corepack` for Node.js < 16.10)
- Install dependencies using `yarn install`

### 1.安装依赖项
# License

```js
npm install nuxt-ui --save
```
[MIT](./LICENSE).
Design resources are published under [CC-BY-ND-4.0](http://creativecommons.org/licenses/by-nd/4.0/).


```js
yarn add nuxt-ui
```

::: tip
如果您使用的是默认主题,您需要先安装[TailwindCSS](https://tailwindcss.com/docs/installation)

或直接下载`nuxt.js` 官方`@nuxtjs/tailwindcss`套件

```js
yarn add @nuxtjs/tailwindcss
```

:::

### 使用

#### 基础配置

::: tip
这里以 nuxt.js 中的使用例子
:::

步骤一:在`plugins`目录中创建`nuxt-ui.js`

```js
import Vue from "vue";
import NuxtUI from "nuxt-ui";
Vue.use(NuxtUI);
```

步骤二:`nuxt.config.js`配置

```js
{
buildModules: ["@nuxtjs/tailwindcss"],
plugins: [
{
src: "~plugins/nuxt-ui",
ssr: false
}
],
}
```

#### 自定义主题

::: tip
在这里您只需要设置覆盖的类即可:
[`plugins/themes/default.js`](https://github.com/516310460/NuxtUI/tree/master/plugins/themes/default.js)
:::

在`plugins`中添加您需要覆盖的主题文件,`plugins/themes/newButton.js`

```js
const NButton = {
// baseClass: 'border block rounded inline-flex items-center justify-center',
baseClass: "rounded-lg border block inline-flex items-center justify-center",
// primaryClass: 'text-white bg-blue-500 border-blue-500 hover:bg-blue-600 hover:border-blue-600',
primaryClass:
"text-white bg-purple-500 border-purple-500 hover:bg-purple-600 hover:border-purple-600"
};

const NewTheme = {
NButton
};

export default NewTheme;
```

## 贡献

您喜欢这个项目吗?欢迎任何帮助。(我不是讲英语的人,因此也欢迎对我的评论有任何评论)。
在提出拉动请求之前,请确保已阅读贡献指南...
由于项目创建之初,还未制定好如何贡献指南,指南制定中....

## 贡献者

- [Hom Wang](https://github.com/516310460)
- [所有贡献者](https://github.com/516310460/NuxtUI/graphs/contributors)

## LICENSE

[MIT](LICENSE)
7 changes: 0 additions & 7 deletions assets/README.md

This file was deleted.

Loading