Socket
Socket
Sign inDemoInstall

svexy-ui

Package Overview
Dependencies
3
Maintainers
1
Versions
13
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    svexy-ui

A design system based Svelte Component Library


Version published
Weekly downloads
0
Maintainers
1
Created
Weekly downloads
 

Readme

Source

Svexy UI

Note

This is an under development project. I have changed the whole library on the basis of design system.

It's a Svelete Component Library which is built using Tailwind CSS. This UI Library focuses on Structure of a Component not on designing it.

This is my first open source package. So please help me to make it best UI Library for Svelte. Everyone is invite to play and help me build this.

Getting started

  • Add following lines into your tailwind config
/** @type {import('tailwindcss').Config} */
const colors = require('tailwindcss/colors.js');
module.exports = {
	content: [
		'./src/**/*.{html,js,svelte,ts}',
		'./node_modules/svexy-ui/components/**/*.{html,js,svelte,ts}'
	],
	theme: {
		colors: {
			gray: colors.gray,
			black: colors.black,
			white: colors.white,
			danger: colors.rose,
			info: colors.sky,
			warning: colors.amber,
			success: colors.teal,
			primary: colors.orange,
			secondary: colors.violet,
			tertiary: colors.rose
		},
		extend: {}
	},
	plugins: []
};
  • Do not change variable names.
  • You can config all the color as per your need but have to follow this method

How to use Button

  • let variants = ['solid', 'outlined', 'soft'] : 'solid' is default.
  • let colors = ['primary', 'secondary', 'tertiary', 'dark', 'info', 'warning', 'danger', 'success'] : 'primary' is default.
  • let sizes = ['xs', 'sm', 'md', 'lg', 'xl'] : 'md' is default.
let variants = ['solid', 'outlined', 'soft'];
let colors = ['primary', 'secondary', 'tertiary', 'dark', 'info', 'warning', 'danger', 'success'];
<script>
  import Button from 'svexy-ui';
</script>
<Button variant={variant} color={color} shadow >Button<Button/>
  • Pass pill if want to rounded.
  • Pass shadow if need shadow of same color.
  • Pass href for <a> tag.
  • Pass disabled for disabled Button
  • POC Documentation
  • Similiar to smelte
  • Inspiration

Authors

Keywords

FAQs

Last updated on 19 Jul 2022

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc