Code Monkey home page Code Monkey logo

tdesign-nuxt's Introduction

@tdesign-vue-next/nuxt

npm version npm downloads License Nuxt

Nuxt Module for TDesign Vue Next.

Features

  • 📦 auto-import components from tdesign-vue-next
  • 🗳 auto-import icons from tdesign-icons-vue-next
  • 🎨 auto-import TDesign global CSS Variables

Quick Setup

  1. Add @tdesign-vue-next/nuxt dependency to your project
# Using pnpm
pnpm add -D @tdesign-vue-next/nuxt

# Using yarn
yarn add --dev @tdesign-vue-next/nuxt

# Using npm
npm install --save-dev @tdesign-vue-next/nuxt
  1. Add @tdesign-vue-next/nuxt to the modules section of nuxt.config.ts
export default defineNuxtConfig({
  modules: ['@tdesign-vue-next/nuxt']
  // self-defined configuration for @tdesign-vue-next/nuxt
  // tdesign:{
  //  resolveIcons:true
  // }
});

All Configuration for @tdesign-vue-next/nuxt

name type default description
resolveIcons boolean false to resolve single icon components from `tdesign-icons-vue-next'
prefix string 't' self-defined the component prefix
iconPrefix string undefined self-defined the icon prefix
iconExclude string or RegExp (string or RegExp)[] undefined exclude icon, if match do not resolve the icon from tdesign-icons-vue-next
iconInclude string or RegExp (string or RegExp)[] undefined included icons, only resolve icons which match iconInclude
esm boolean false whether to import ESM version
plugins TdesignPlugin[] undefined self-defined import plugin from tdesign-vue-next
exclude string or RegExp (string or RegExp)[] undefined exclude component name, if match do not resolve the name
include string or RegExp (string or RegExp)[] undefined included component, only resolve component which match include

That's it! You can now use Nuxt Module for TDesign in your Nuxt app ✨

Development

# Install dependencies
npm install

# Generate type stubs
npm run dev:prepare

# Develop with the playground
npm run dev

# Build the playground
npm run dev:build

# Run ESLint
npm run lint

# Run Vitest
npm run test
npm run test:watch

# Release new version
npm run release

tdesign-nuxt's People

Contributors

uyarn avatar liweijie0812 avatar timi137137 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.