1.5.2 • Published 2 months ago
@mockline/utils v1.5.2
Features
- Everything you need: Mockline Utils is a minimal utility library for Mockline.
- TailwindCSS v4 Alpha is directly integrated, so you can use all the power of TailwindCSS with zero configuration.
- Icons provided by Nuxt Icon, U can use any icon from Lucide, Heroicons, etc...
- Toasts are also provided by Vue Sonner, so you can easily create beautiful toasts with ease.
- Fonts are provided by Nuxt Fonts, so you can easily use any font with magic 🧙♂️.
- Themes are provided by Color Mode, so you can easily switch between light and dark modes or even create your own themes.
- Fully customizable: All components are customizable via props and slots.
- Dark mode: Enjoy a seamless dark mode experience with no additional setup.
- Easy to use: Mockline is designed to be beginner-friendly, with a simple setup process.
- Community-driven: Join the Mockline community on Discord to connect with other users and share your feedback.
- Open-source: Mockline is open-source, and we welcome contributions from the community.
Quick Setup
For the moment Mockline is only available for Nuxt projects (Vue 3 support and react support will be added soon). To get started, follow these steps:
You can automatically install Mockline Utils in your Nuxt project using the following command:
npx nuxi@latest module add @mockline/utils
or install it manually:
- Add
@mockline/utils
dependency to your project
# Using bun
bun install -D @mockline/utils
# Using pnpm
pnpm add -D @mockline/utils
# Using yarn
yarn add --dev @mockline/utils
# Using npm
npm install --save-dev @mockline/utils
- Add
@mockline/utils
to themodules
section ofnuxt.config.ts
export default defineNuxtConfig({
modules: [
'@mockline/utils'
]
})
Then you will need to import the mockline css in your app.vue
file:
<template>
<MApp>
<!-- Your app content -->
<MToasts />
</MApp>
</template>
<style>
@import "@mockline/utils";
</style>
That's it! You can now use Mockline Utils in your Nuxt app ✨
Community
The Mockline community can be found on Discord, to chat with other community members, you can join the Mockline Discord.
Contributing
To start contributing, you can follow these steps:
- First raise an issue to discuss the changes you would like to make.
- Fork the repository.
- Create a branch using conventional commits and the issue number as the branch name. For example,
feat/123
orfix/456
. - Make changes following the local development steps.
- Commit your changes following the Conventional Commits specification.
- If your changes affect the code, run tests using
bun run test
. - Create a pull request following the Pull Request Template.
- To be merged, the pull request must pass the tests/workflow and have at least one approval.
- If your changes affect the documentation, make sure to update it.
- If your changes affect the code, make sure to update the tests.
- Wait for the maintainers to review your pull request.
- Once approved, the pull request will be merged in the next release !
- Clone this repository
- Install latest LTS version of Node.js
- Enable Corepack using
corepack enable
- Install dependencies using
bun install
Published under the APACHE license. Made by @HugoRCD and community 💛
🤖 auto updated with automd (last updated: Tue Oct 08 2024)