@nuxt/ui 0.4.1 → 2.8.1

package/LICENSE.md

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2023 NuxtLabs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,16 +1,44 @@
-# Nuxt UI Components
+[![nuxt-ui-social-card](https://repository-images.githubusercontent.com/428329515/43fec891-9030-4601-8233-5d45ba5c6013)](https://ui.nuxt.com)
 
-<a href="https://www.npmjs.com/package/@nuxt/ui-edge"><img src="https://flat.badgen.net/npm/v/@nuxt/ui-edge"></a>
+# Nuxt UI
 
-UI kit for Nuxt 3's examples and internal tooling UI.
+[![npm version][npm-version-src]][npm-version-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
+[![License][license-src]][license-href]
+[![Nuxt][nuxt-src]][nuxt-href]
 
-> Note: This library is heavily working in progress and does not serve as a generic UI library (for now). It is not recommended to use it in production.
+Nuxt UI provides everything related to UI when building Nuxt applications: components, icons, colors, dark mode and also keyboard shortcuts.
 
-🏀 [Online Playground](https://components.ui.nuxtjs.org)
+Is has been developed by [NuxtLabs](https://nuxtlabs.com/) for [Volta](https://volta.net), [Nuxt Studio](https://nuxt.studio/) and the Nuxt community.
 
-## Install
+## Features
 
-```ts
+- Built with [Headless UI](https://headlessui.dev/) and [Tailwind CSS](https://tailwindcss.com/)
+- HMR support through Nuxt App Config
+- Dark mode support
+- Support for LTR and RTL languages
+- Keyboard shortcuts
+- Bundled icons
+- Fully typed
+
+Read more on [ui.nuxt.com](https://ui.nuxt.com)
+
+## Installation
+
+```bash
+# Using npm
+npm install @nuxt/ui
+
+# Using yarn
+yarn add @nuxt/ui
+
+# Using pnpm
+pnpm add @nuxt/ui
+```
+
+Then, register the module in your `nuxt.config.ts`:
+
+```js
 export default defineNuxtConfig({
   modules: [
     '@nuxt/ui'
@@ -18,58 +46,43 @@ export default defineNuxtConfig({
 })
 ```
 
-## Usage
-
-Nuxt UI is an unbundled component library powered by [UnoCSS](https://github.com/antfu/unocss) and [VueUse](https://vueuse.org/).
+If you want latest updates, please use `@nuxt/ui-edge` in your `package.json`:
 
-In Nuxt UI, we introduced the `n` attribute for every component to customize the styles and variations. For example, to make a red button:
-
-```html
-<NButton n="red" />
+```json
+{
+  "devDependencies": {
+    "@nuxt/ui": "npm:@nuxt/ui-edge@latest"
+  }
+}
 ```
 
-to make it larger, add the size specifier (`sm`, `md`, `lg` or `xl`) the `n` attribute:
+## Documentation
 
-```html
-<NButton n="red xl" />
-```
+Visit https://ui.nuxt.com to explore the documentation.
 
-You can apply the same specifiers to any other component, for example:
+## Credits
 
-```html
-<NCheckbox n="red xl" />
-```
+- [nuxt/nuxt](https://github.com/nuxt/nuxt)
+- [nuxt-modules/color-mode](https://github.com/nuxt-modules/color-mode)
+- [nuxt-modules/tailwindcss](https://github.com/nuxt-modules/tailwindcss)
+- [tailwindlabs/tailwindcss](https://github.com/tailwindlabs/tailwindcss)
+- [tailwindlabs/headlessui](https://github.com/tailwindlabs/headlessui)
+- [vueuse/vueuse](https://github.com/vueuse/vueuse)
+- [egoist/tailwindcss-icons](https://github.com/egoist/tailwindcss-icons)
 
-Apply it to parent components could make a local theme scope
+## License
 
-```html
-<NCard n="green-500">
-  <!-- both of them are themed green -->
-  <NCheckbox>i accept the terms & conditions</NCheckbox>
-  <NButton>Submit</NButton>
-</NCard>
-```
+Licensed under the [MIT license](https://github.com/nuxt/ui/blob/dev/LICENSE.md).
 
-## Theming
+<!-- Badges -->
+[npm-version-src]: https://img.shields.io/npm/v/@nuxt/ui/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
+[npm-version-href]: https://npmjs.com/package/@nuxt/ui
 
-Powered by [UnoCSS](https://github.com/antfu/unocss), you can use Tailwind/Windi CSS utilities to quickly customize the look and feel of components.
+[npm-downloads-src]: https://img.shields.io/npm/dm/@nuxt/ui.svg?style=flat&colorA=18181B&colorB=28CF8D
+[npm-downloads-href]: https://npmjs.com/package/@nuxt/ui
 
-It's also possible to override the default theme globally, for example:
-
-```ts
-// nuxt.config.js
-export default defineNuxtConfig({
-  modules: [
-    '@nuxt/ui'
-  ],
-  unocss: {
-    shortcuts: {
-      'n-button-base': 'border n-border-base rounded shadow-sm op80 !outline-none',
-      'n-button-hover': 'op100 !border-context text-context',
-      'n-button-active': 'n-active-base bg-context/5',
-    }
-  }
-})
-```
+[license-src]: https://img.shields.io/github/license/nuxt/ui.svg?style=flat&colorA=18181B&colorB=28CF8D
+[license-href]: https://github.com/nuxt/ui/blob/main/LICENSE
 
-You can find all the default values and available entries in [src/unocss/index.ts](./src/unocss/index.ts).
+[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js
+[nuxt-href]: https://nuxt.com

package/dist/module.cjs

@@ -0,0 +1,5 @@
+module.exports = function(...args) {
+  return import('./module.mjs').then(m => m.default.call(this, ...args))
+}
+const _meta = module.exports.meta = require('./module.json')
+module.exports.getMeta = () => Promise.resolve(_meta)