Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: create checkbox plugin component #41

Merged
merged 3 commits into from
Jul 23, 2023
Merged

feat: create checkbox plugin component #41

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
300e03f
feat: create checkbox plugin component
bpsmartdesign Jul 14, 2023
c42964a
fix: remove additional single quote
driss-chelouati Jul 15, 2023
089e43a
Merge branch 'main' into feat/checkbox
stafyniaksacha Jul 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,55 @@ export default withShurikenUI({
theme: {
extend: {
shurikenUi: {
checkbox: {
outer: {
size: '5',
},
inner: {
border: 'muted-400',
borderDark: 'muted-700',
bg: 'white',
bgDark: 'muted-700',
size: 'full',
},
check: {
size: '2.5',
duration: '300',
},
indeterminate: {
size: '2.5',
duration: '300',
},
input: {
size: '5',
},
labelText: {
text: 'muted-400',
font: 'sans',
textSize: 'sm',
},
error: {
text: 'danger-600',
font: 'sans',
textSixe: 'xs',
},
rounded: {
smooth: 'md',
curved: 'lg',
full: 'full',
},
default: {
text: 'muted-600',
textDark: 'muted-200',
},
light: 'white',
muted: 'muted-400',
primary: 'primary-500',
info: 'info-500',
success: 'success-500',
warning: 'warning-500',
danger: 'danger-500',
},
dropdownDivider: {
space: '2',
border: 'muted-200', // you can use arbitrary value like '[#fff]'
Expand Down
166 changes: 166 additions & 0 deletions src/plugins/components/checkbox.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,166 @@
import plugin from 'tailwindcss/plugin'
import { defu } from 'defu'
import { type PluginOption, defaultPluginOptions } from '../options'

const defaultCheckboxConfig = {
outer: {
size: '5',
},
inner: {
border: 'muted-400',
borderDark: 'muted-700',
bg: 'white',
bgDark: 'muted-700',
size: 'full',
},
check: {
size: '2.5',
duration: '300',
},
indeterminate: {
size: '2.5',
duration: '300',
},
input: {
size: '5',
},
labelText: {
text: 'muted-400',
font: 'sans',
textSize: 'sm',
},
error: {
text: 'danger-600',
font: 'sans',
textSixe: 'xs',
},
rounded: {
smooth: 'md',
curved: 'lg',
full: 'full',
},
default: {
text: 'muted-600',
textDark: 'muted-200',
},
light: 'white',
muted: 'muted-400',
primary: 'primary-500',
info: 'info-500',
success: 'success-500',
warning: 'warning-500',
danger: 'danger-500',
}

export default plugin.withOptions(
function (options: PluginOption) {
const { prefix } = defu(options, defaultPluginOptions)

return function ({ addComponents, theme }) {
const config = theme(
'shurikenUi.checkbox'
) satisfies typeof defaultCheckboxConfig

addComponents({
[`.${prefix}-checkbox`]: {
[`@apply relative inline-flex items-start gap-1`]: {},

[`.${prefix}-checkbox-outer`]: {
[`@apply ${prefix}-focus relative flex h-${config.outer.size} w-${config.outer.size} shrink-0 cursor-pointer items-center justify-center overflow-hidden`]:
{},
},
[`.${prefix}-checkbox-inner`]: {
[`@apply border-${config.inner.border} dark:border-${config.inner.borderDark} dark:bg-${config.inner.bgDark} absolute start-0 top-0 z-0 h-${config.inner.size} w-${config.inner.size} border-2 bg-${config.inner.bg}`]:
{},
},
[`.${prefix}-icon-check`]: {
[`@apply pointer-events-none absolute z-10 h-${config.check.size} w-${config.check.size} fill-current translate-y-6 opacity-0 transition duration-${config.check.duration}`]:
{},
},
[`.${prefix}-icon-indeterminate`]: {
[`@apply pointer-events-none absolute z-10 h-${config.indeterminate.size} w-${config.indeterminate.size} fill-current translate-y-6 opacity-0 transition duration-${config.indeterminate.duration}`]:
{},
},
[`.${prefix}-checkbox-input`]: {
[`@apply absolute z-20 h-${config.input.size} w-${config.input.size} cursor-pointer opacity-0`]:
{},

[`&:checked ~ .${prefix}-checkbox-inner, &:indeterminate ~ .${prefix}-checkbox-inner`]:
{
[`@apply border-current dark:border-current`]: {},
},

[`&:checked ~ .${prefix}-icon-check`]: {
[`@apply translate-y-0 opacity-100`]: {},
},

[`&:indeterminate ~ .${prefix}-icon-check`]: {
[`@apply !translate-y-6`]: {},
},

[`&:indeterminate ~ .${prefix}-icon-indeterminate`]: {
[`@apply !translate-y-0 !opacity-100`]: {},
},
},
[`.${prefix}-checkbox-label-wrapper`]: {
[`@apply inline-flex flex-col`]: {},
},
[`.${prefix}-checkbox-label-text`]: {
[`@apply text-${config.labelText.text} ms-1 cursor-pointer select-none font-${config.labelText.font} text-${config.labelText.textSize}`]:
{},
},
[`.${prefix}-checkbox-error`]: {
[`@apply text-${config.error.text} ms-1 inline-block font-${config.error.font} text-${config.error.textSixe}`]:
{},
},
[`&.${prefix}-checkbox-rounded .${prefix}-checkbox-inner`]: {
[`@apply rounded`]: {},
},
[`&.${prefix}-checkbox-smooth .${prefix}-checkbox-inner`]: {
[`@apply rounded-${config.rounded.smooth}`]: {},
},
[`&.${prefix}-checkbox-curved .${prefix}-checkbox-inner`]: {
[`@apply rounded-${config.rounded.curved}`]: {},
},
[`&.${prefix}-checkbox-full .${prefix}-checkbox-inner`]: {
[`@apply rounded-${config.rounded.full}`]: {},
},
[`&.${prefix}-checkbox-default`]: {
[`@apply text-${config.default.text} dark:text-${config.default.textDark}`]:
{},
},
[`&.${prefix}-checkbox-light`]: {
[`@apply text-${config.light}`]: {},
},
[`&.${prefix}-checkbox-muted`]: {
[`@apply text-${config.muted}`]: {},
},
[`&.${prefix}-checkbox-primary`]: {
[`@apply text-${config.primary}`]: {},
},
[`&.${prefix}-checkbox-info`]: {
[`@apply text-${config.info}`]: {},
},
[`&.${prefix}-checkbox-success`]: {
[`@apply text-${config.success}`]: {},
},
[`&.${prefix}-checkbox-warning`]: {
[`@apply text-${config.warning}`]: {},
},
[`&.${prefix}-checkbox-danger`]: {
[`@apply text-${config.danger}`]: {},
},
},
})
}
},
function () {
return {
theme: {
shurikenUi: {
checkbox: defaultCheckboxConfig,
},
},
}
}
)
2 changes: 2 additions & 0 deletions src/plugins/components/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import plugin from 'tailwindcss/plugin'
import { defu } from 'defu'
import { type PluginOption } from '../options'
import checkbox from './checkbox'
import dropdown from './dropdown'
import focus from './focus'
import label from './label'
Expand All @@ -11,6 +12,7 @@ import slimscroll from './slimscroll'
import tooltip from './tooltip'

const components = [
checkbox,
dropdown,
focus,
label,
Expand Down