@djcali570/component-lib 0.1.5 → 0.1.7

package/README.md

@@ -1,241 +1,65 @@
-# DJCali570 Svelte 5 Component Library
+# Svelte library
 
-Components make use of Svelte's runes so will only work with Svelte 5
+Everything you need to build a Svelte library, powered by [`sv`](https://npmjs.com/package/sv).
 
-## Input
+Read more about creating a library [in the docs](https://svelte.dev/docs/kit/packaging).
 
-Use default or customize the input color scheme
+## Creating a project
 
-```bash
-import { Input5 } from '@djcali570/component-lib';
-import type { Input5ColorScheme } from '@djcali570/component-lib';
+If you're seeing this, you've probably already done this step. Congrats!
 
-let ics: Input5ColorScheme = {
-	mainTextColor: '#D6D6D6',
-	mainBgColor: '#121212',
-	titleColor: '#989A9A'
-}
-```
-
-#### Features
-- Counter
-- readonly / disabled options
-- onUpdate Callback
-- types: Text, Number or Password
-- Input formatting
-- Input or Textarea
-
-### Use of the Input component
-
-```
-<Input5 title="Input Title" colorScheme={ics} validator="phone" />
-```
-
-## Accordion
-
-Use default or customize the accordion color scheme
-
-```bash
-import { Accordion5 } from '@djcali570/component-lib';
-import type { Accordion5ColorScheme } from '@djcali570/component-lib';
-
-let acs: Accordion5ColorScheme = {
-		bgColor: '#121212',
-		textColor: '#D6D6D6',
-		triggerColor: '#D6D6D6'
-}
-```
-
-#### Props
-
-- title (Snippet) - Snippet for title content
-- panel (Snippet) - Snippet for accordion content
-- iconWidth (string) - Width of icon eg. "1rem"
-- iconHeight (string) - Height of icon eg. "1rem"
-
-### Use of the Accordion component
-
-```
-<Accordion5 colorScheme={acs}>
-	{#snippet title()}
-		<h1>My Title</h1>
-	{/snippet}
-    {#snippet panel()}
-        <p>Accordion Contents</p>
-    {/snippet}
-</Accordion5>
-```
-
-## Chart
-
-Use the default or customize the chart color scheme
-
-```bash
-import { Chart5 } from '@djcali570/component-lib';
-import type { Chart5ColorScheme } from '@djcali570/component-lib';
+```sh
+# create a new project in the current directory
+npx sv create
 
-let ccs: Chart5ColorScheme = {
-	bgColor: '#121212',
-	gridLineColor: '#303030',
-	xAxisTextColor: '#5ac1dd',
-	yAxisTextColor: '#5ac1dd'
-}
+# create a new project in my-app
+npx sv create my-app
 ```
 
-#### Props
-- title (Snippet) - Use for title of chart
-- maxWidth (string) - Sets the max width of chart eg. "400px"
-- height (string) - Sets the height of the chart eg. "400px"
-- labels (string[]) - Array of strings for the labels
-- values (number[]) - Array of numbers for the values
+To recreate this project with the same configuration:
 
-### Use of the Chart component
-
-```
-let labels: string[] = ['Label1', 'label2'];
-let values: number[] = [35, 20];
-
-<Chart5 {labels} {values} colorScheme={ccs} height="300px">
-	{#snippet title()}
-		<p>My Title</p>
-	{/snippet}
-</Chart5>
+```sh
+# recreate this project
+pnpm dlx sv create --template library --types ts --add prettier eslint sveltekit-adapter="adapter:node" devtools-json --install pnpm component-lib-restored
 ```
 
-## Admin Panel
-
-Use the default or customize the color scheme
-
-```bash
-import { AdminPanel5 } from '@djcali570/component-lib';
-import type { AdminPanel5ColorScheme } from '@djcali570/component-lib';
+## Developing
 
-let apcs: AdminPanel5ColorScheme = {
-	panelMenuBgColor: '#181818',
-	panelBgColor: '#151515',
-	drawerBgColor: '#121212',
-	drawerTitleBgColor: '#151515',
-	iconColor: '#D6D6D6'
-}
-```
+Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
 
-### Use of the Admin Panel component
+```sh
+npm run dev
 
-```
-<AdminPanel5>
-	{#snippet navigation()}
-		<div>This is Navigation</div>
-	{/snippet}
-	{#snippet title()}
-		<div style="display: flex; align-items:center; height:100%; width:100%;">
-			<p style="color: #fff;">Title</p>
-		</div>
-	{/snippet}
-	{#snippet panel()}
-		<div style="display: flex; align-items:center; width:100%; padding:1em;">
-			<p style="color: #fff;">This is the content</p>
-		</div>
-	{/snippet}
-	{#snippet drawerTitle()}
-		<div
-			style="display:flex; justify-content:flex-start; align-items:center; width: 100%; height:100%;"
-		>
-			<div style="color: white;">This is a drawer title</div>
-		</div>
-	{/snippet}
-</AdminPanel5>
+# or start the server and open the app in a new browser tab
+npm run dev -- --open
 ```
 
-## Bottom Sheet
+Everything inside `src/lib` is part of your library, everything inside `src/routes` can be used as a showcase or preview app.
 
-Use the default or customize the color scheme
+## Building
 
-```bash
-import { BottomSheet5 } from '@djcali570/component-lib';
-import type { BottomSheet5ColorScheme } from '@djcali570/component-lib';
+To build your library:
 
-let bscs: BottomSheet5ColorScheme = {
-	bgColor: '#121212',
-}
+```sh
+npm pack
 ```
-#### Props
-- modalStatus (boolean) - bindable to close/open modal outside component
-- content (Snippet) - Snippet for sheet content
-- rounded (boolean) - Set rounded corners to top
-- top (string) - Set height of bottom sheet. eg. "50%", "1rem"
 
-### Use of the component
-
-```
-let modalStatus = $state(false);
+To create a production version of your showcase app:
 
-<BottomSheet5 bind:modalStatus top="50%">
-	{#snippet content()}
-		<div>Place bottom sheet content here</div>
-	{/snippet}
-</BottomSheet5>
+```sh
+npm run build
 ```
 
-## Dialog
+You can preview the production build with `npm run preview`.
 
-Use the default or customize the color scheme
+> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment.
 
-```bash
-import { Dialog5 } from '@djcali570/component-lib';
-import type { Dialog5ColorScheme } from '@djcali570/component-lib';
+## Publishing
 
-let d5cs: Dialog5ColorScheme = {
-		bgColor: '#121212',
-        titleBgColor: '#181818',
-		textColor: '#fcfcfc',
-        confirmTextColor: '#fb2c36',
-		borderColor: '#262626',
-		okButtonBgColor: '#181818',
-		confirmButtonBgColor: '#181818'
-}
-```
-#### Props
-- modalStatus (boolean) - bindable to close/open modal outside component
-- minWidth / minHeight (string) - set height or width of the dialog. eg '320px'
-- dialogType ('confirm-cancel' | 'ok') - use ok for a simple message or use confirm/cancel to use the onUpdate callback.
-- title (Snippet) - use for title section of the dialog
-- content (Snippet) - use for the content or message of the dialog
-- confirmButtonText / cancelButtonText / okButtonText (string) - Change default button text
-- onUpdate ((value: boolean) => void)) - Callback for the cancel/confirm button.
+Go into the `package.json` and give your package the desired name through the `"name"` option. Also consider adding a `"license"` field and point it to a `LICENSE` file which you can create from a template (one popular option is the [MIT license](https://opensource.org/license/mit/)).
 
-### Use of the component
+To publish your library to [npm](https://www.npmjs.com):
 
+```sh
+npm publish
 ```
-let modalStatus = $state(false);
-
-function dialogUpdated(v: boolean) {
-	console.log(v);
-}
-
-<Dialog5
-bind:modalStatus
-dialogType="confirm-cancel"
-onUpdate={(v) => dialogUpdated(v)}
->
-{#snippet title()}
-	<div style="width: 100%; display: flex; justify-content: center; padding: 1rem;">
-		Dialog Title
-	</div>
-{/snippet}
-{#snippet content()}
-	<div>Place dialog content here</div>
-{/snippet}
-</Dialog5>
-```
-
-
-# Updates
-#### 0.1.5	- Fixed issue where Accordion did not handle dynamic content.
-#### 0.1.4	- Updated Accordion component to add innerPadding prop.
-#### 0.1.3	- Updated Time Picker to allow binding to timeText.
-#### 0.1.2	- Fixed some minor styling issues with Dialog component.
-#### 0.1.1	- Added Bottom Sheet component & Dialog component.
-#### 0.1.0	- Updated Accordion component to use snippets for title.
-#### 0.0.14	- Fixed Input5 textarea height was not being applied. Removed Tailwind dependencies.
-#### 0.0.13	- Added Admin Panel 5 Component.
-#### 0.0.12	- Made all components colorScheme properties optional.

package/dist/Checkbox5.svelte

@@ -0,0 +1,119 @@
+<script lang="ts">
+	let {
+		colorScheme: partialColorScheme = {},
+		name = 'checkbox',
+		title = 'Title',
+		checked = $bindable(false),
+		disabled = false,
+		hideText = false,
+		onChange = (checked: boolean) => {}
+	}: {
+		colorScheme?: Partial<{
+			mainTextColor: string;
+			mainBgColor: string;
+			borderColor: string;
+			focusedColor: string;
+			checkmarkColor: string;
+		}>;
+		name?: string;
+		title?: string;
+		checked?: boolean;
+		disabled?: boolean;
+		hideText?: boolean;
+		onChange?: (checked: boolean) => void;
+	} = $props();
+
+	const defaultColorScheme = {
+		mainTextColor: '#D6D6D6',
+		mainBgColor: '#121212',
+		borderColor: '#262626',
+		focusedColor: '#5ac1dd',
+		checkmarkColor: '#5ac1dd'
+	};
+
+	// svelte-ignore state_referenced_locally
+	const colorScheme = { ...defaultColorScheme, ...partialColorScheme };
+	const id = `checkbox-${Math.random().toString(36).slice(2, 8)}`;
+
+	$effect(() => {
+		onChange(checked);
+	});
+</script>
+
+<div
+	class="air5__checkbox__container"
+	style="
+    --air5__mainTextColor: {colorScheme.mainTextColor};
+    --air5__mainBgColor: {colorScheme.mainBgColor};
+    --air5__borderColor: {colorScheme.borderColor};
+    --air5__focusedColor: {colorScheme.focusedColor};
+    --air5__checkmarkColor: {colorScheme.checkmarkColor};
+  "
+>
+	<label for={id}>
+		<input type="checkbox" {id} {name} bind:checked {disabled} />
+		<span class="air5__checkbox__custom">
+			{#if checked}
+				<svg viewBox="0 0 24 24">
+					<path
+						fill="currentColor"
+						d="M18 6 L6 18 M6 6 L18 18"
+						stroke="currentColor"
+						stroke-width="2"
+						stroke-linecap="round"
+					/>
+				</svg>
+			{/if}
+		</span>
+		{#if !hideText}
+			<span class="air5__checkbox__title">{title}</span>
+		{/if}
+	</label>
+</div>
+
+<style>
+	.air5__checkbox__container {
+		display: flex;
+		flex-direction: column;
+		font-family: inherit;
+		color: var(--air5__mainTextColor);
+	}
+
+	input[type='checkbox'] {
+		display: none;
+	}
+
+	label {
+		display: flex;
+		align-items: center;
+		cursor: pointer;
+	}
+
+	.air5__checkbox__custom {
+		width: 32px;
+		height: 32px;
+		border: 1px solid var(--air5__borderColor);
+		border-radius: 0.25rem;
+		background-color: var(--air5__mainBgColor);
+		display: flex;
+		align-items: center;
+		justify-content: center;
+		margin-right: 0.5rem;
+		transition: box-shadow 0.2s ease;
+	}
+
+	label:focus-within .air5__checkbox__custom,
+	label:hover .air5__checkbox__custom {
+		box-shadow: 0 0 0 2px var(--air5__focusedColor);
+	}
+
+	.air5__checkbox__custom svg {
+		width: 24px;
+		height: 24px;
+		color: var(--air5__checkmarkColor);
+	}
+
+	.air5__checkbox__title {
+		font-size: 0.875rem;
+	}
+</style>

package/dist/Checkbox5.svelte.d.ts

@@ -0,0 +1,18 @@
+type $$ComponentProps = {
+    colorScheme?: Partial<{
+        mainTextColor: string;
+        mainBgColor: string;
+        borderColor: string;
+        focusedColor: string;
+        checkmarkColor: string;
+    }>;
+    name?: string;
+    title?: string;
+    checked?: boolean;
+    disabled?: boolean;
+    hideText?: boolean;
+    onChange?: (checked: boolean) => void;
+};
+declare const Checkbox5: import("svelte").Component<$$ComponentProps, {}, "checked">;
+type Checkbox5 = ReturnType<typeof Checkbox5>;
+export default Checkbox5;

package/dist/index.d.ts

@@ -5,8 +5,9 @@ import TimePicker5 from "./TimePicker5.svelte";
 import Accordion5 from "./Accordion5.svelte";
 import Chart5 from "./Chart5.svelte";
 import AdminPanel5 from "./AdminPanel5.svelte";
-import type { Input5ColorScheme, DatePicker5ColorScheme, TimePicker5ColorScheme, DropDownItem, DropDown5ColorScheme, Accordion5ColorScheme, Chart5ColorScheme, AdminPanel5ColorScheme, BottomSheet5ColorScheme, Dialog5ColorScheme } from "./types.js";
+import Checkbox5 from "./Checkbox5.svelte";
+import type { Input5ColorScheme, DatePicker5ColorScheme, TimePicker5ColorScheme, DropDownItem, DropDown5ColorScheme, Accordion5ColorScheme, Chart5ColorScheme, AdminPanel5ColorScheme, BottomSheet5ColorScheme, Dialog5ColorScheme, Checkbox5ColorScheme } from "./types.js";
 import BottomSheet5 from "./BottomSheet5.svelte";
 import Dialog5 from "./Dialog5.svelte";
-export { DatePicker5, Input5, DropDown5, TimePicker5, Accordion5, Chart5, AdminPanel5, BottomSheet5, Dialog5 };
-export type { Input5ColorScheme, DatePicker5ColorScheme, TimePicker5ColorScheme, Accordion5ColorScheme, DropDown5ColorScheme, DropDownItem, Chart5ColorScheme, AdminPanel5ColorScheme, BottomSheet5ColorScheme, Dialog5ColorScheme };
+export { DatePicker5, Input5, DropDown5, TimePicker5, Accordion5, Chart5, AdminPanel5, BottomSheet5, Dialog5, Checkbox5 };
+export type { Input5ColorScheme, DatePicker5ColorScheme, TimePicker5ColorScheme, Accordion5ColorScheme, DropDown5ColorScheme, DropDownItem, Chart5ColorScheme, AdminPanel5ColorScheme, BottomSheet5ColorScheme, Dialog5ColorScheme, Checkbox5ColorScheme };

package/dist/types.d.ts

@@ -89,3 +89,11 @@ export interface Dialog5ColorScheme {
     okButtonBgColor?: string;
     confirmButtonBgColor?: string;
 }
+
+export interface Checkbox5ColorScheme {
+    mainTextColor?: string;
+    mainBgColor?: string;
+    borderColor?: string;
+    focusedColor?: string;
+    checkmarkColor?: string;
+}

package/package.json

@@ -1,64 +1,64 @@
 {
-  "name": "@djcali570/component-lib",
-  "version": "0.1.5",
-  "files": [
-    "dist",
-    "!dist/**/*.test.*",
-    "!dist/**/*.spec.*"
-  ],
-  "sideEffects": [
-    "**/*.css"
-  ],
-  "svelte": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "type": "module",
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "svelte": "./dist/index.js"
-    }
-  },
-  "peerDependencies": {
-    "@sveltejs/kit": "^2.16.0",
-    "svelte": "^5.0.0"
-  },
-  "devDependencies": {
-    "@eslint/compat": "^1.2.5",
-    "@eslint/js": "^9.18.0",
-    "@sveltejs/adapter-auto": "^6.0.0",
-    "@sveltejs/kit": "^2.16.0",
-    "@sveltejs/package": "^2.0.0",
-    "@sveltejs/vite-plugin-svelte": "^5.0.0",
-    "@tailwindcss/vite": "^4.0.0",
-    "eslint": "^9.18.0",
-    "eslint-config-prettier": "^10.0.1",
-    "eslint-plugin-svelte": "^3.0.0",
-    "globals": "^16.0.0",
-    "prettier": "^3.4.2",
-    "prettier-plugin-svelte": "^3.3.3",
-    "publint": "^0.3.2",
-    "svelte": "^5.0.0",
-    "svelte-check": "^4.0.0",
-    "typescript": "^5.0.0",
-    "typescript-eslint": "^8.20.0",
-    "vite": "^6.2.6"
-  },
-  "keywords": [
-    "svelte",
-    "SvelteKit",
-    "components"
-  ],
-  "author": {
-    "name": "Jay Cali"
-  },
-  "scripts": {
-    "dev": "vite dev",
-    "build": "vite build && npm run prepack",
-    "package": "svelte-kit sync && svelte-package && publint",
-    "preview": "vite preview",
-    "check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json",
-    "check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch",
-    "format": "prettier --write .",
-    "lint": "prettier --check . && eslint ."
-  }
+	"name": "@djcali570/component-lib",
+	"version": "0.1.7",
+	"files": [
+		"dist",
+		"!dist/**/*.test.*",
+		"!dist/**/*.spec.*"
+	],
+	"sideEffects": [
+		"**/*.css"
+	],
+	"svelte": "./dist/index.js",
+	"types": "./dist/index.d.ts",
+	"type": "module",
+	"exports": {
+		".": {
+			"types": "./dist/index.d.ts",
+			"svelte": "./dist/index.js"
+		}
+	},
+	"peerDependencies": {
+		"svelte": "^5.0.0"
+	},
+	"devDependencies": {
+		"@eslint/compat": "^2.0.2",
+		"@eslint/js": "^9.39.2",
+		"@sveltejs/adapter-node": "^5.5.2",
+		"@sveltejs/kit": "^2.50.2",
+		"@sveltejs/package": "^2.5.7",
+		"@sveltejs/vite-plugin-svelte": "^6.2.4",
+		"@types/node": "^22",
+		"eslint": "^9.39.2",
+		"eslint-config-prettier": "^10.1.8",
+		"eslint-plugin-svelte": "^3.14.0",
+		"globals": "^17.3.0",
+		"prettier": "^3.8.1",
+		"prettier-plugin-svelte": "^3.4.1",
+		"publint": "^0.3.17",
+		"svelte": "^5.49.2",
+		"svelte-check": "^4.3.6",
+		"typescript": "^5.9.3",
+		"typescript-eslint": "^8.54.0",
+		"vite": "^7.3.1",
+		"vite-plugin-devtools-json": "^1.0.0"
+	},
+	"keywords": [
+		"svelte",
+		"SvelteKit",
+		"components"
+	],
+	"author": {
+		"name": "Jay Cali"
+	},
+	"scripts": {
+		"dev": "vite dev",
+		"build": "vite build && npm run prepack",
+		"package": "svelte-kit sync && svelte-package && publint",
+		"preview": "vite preview",
+		"check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json",
+		"check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch",
+		"format": "prettier --write .",
+		"lint": "prettier --check . && eslint ."
+	}
 }