kudu-components v0.1.0
Kudu Components
Comprehensive collection of reusable UI components, used across all products developed by Kudu.
Install package
Note:
In order to the
kudu-componentspackage to work correctly, you need to havekudu-ui-systemconfigured in your project beforehand. You can learn how to configurekudu-ui-componentsin your project by following this link.
After installing ppnpm, kudu-ui-system, you can install kudu-components with this command:
pnpm i kudu-componentsTo utilize components encompassed on the web3 path like ModalConnectWallet, you need to install wagmi and viempackages it into your project. Please refer to the documentation of wagmi/core for know more.
Usage
- In your
tailwind.config.jsspecify the content ofkudu-componentsshould be processed by Tailwind CSS during the build process
/** @type {import('tailwindcss').Config} */
export default {
content: [...'./node_modules/kudu-components/**/*.{html,js,svelte,ts}']
}- Exclude the
kudu-componentspackage from the optimized dependencies in yourvite.config.js.
export default defineConfig(() => ({
...
optimizeDeps: {
exclude: ['kudu-components']
},
...
}))- Import and use any
kudu-components
<script>
import { LinkedIn } from 'kudu-components/icons'
</script>
<a
href="https://www.linkedin.com/company/kudu-consultant-llc"
class="btn btn-square btn-ghost child:w-7 child:h-7"
>
<Linkedin />
</a>Development
TODO
Changelog
If you want to know the different changes between versions of this package, look at the changelog here.
I have an issue, what should I do?
Please file the issue here.
Contributing
License
By contributing to kudu-components, you agree that your contributions will be licensed under the LICENSE of the project.