drab 2.8.6 → 3.0.0

package/README.md

@@ -1,67 +1,69 @@
-# An unstyled Svelte component library
-
-- [GitHub](https://github.com/rossrobino/drab)
-- [npm](https://www.npmjs.com/package/drab)
-- [MIT License](https://github.com/rossrobino/drab/blob/main/LICENSE.md)
-- One dependency - [Svelte](https://svelte.dev)
-
-## About
-
-**drab** focuses on providing JavaScript functionality where it's most useful, while leaving out components that can be easily created using HTML, such as a label or badge. Whenever possible, components are [progressively enhanced](/docs/ShareButton) or provide a fallback [noscript](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/noscript) message. Additionally, transitions are disabled for users who prefer reduced motion.
-
-This library takes a more opinionated approach compared to some headless UI libraries by providing the basic HTML structure for every component, as well as default positioning for elements like the [sheet](/docs/Sheet) or [popover](/docs/Popover). However, these components can still be further customized using styles, [slots](https://svelte.dev/tutorial/slots), and [slot props](https://svelte.dev/tutorial/slot-props).
-
-Components without styles can appear rather drab. You have the freedom to bring your own styles to these components! Using unstyled components allows you to selectively choose what you need, seamlessly integrate with existing designs, and avoid being tied to any specific library.
-
-To style the components, you can make use of [global styles](https://joyofcode.xyz/global-styles-in-sveltekit). This process can be expedited by utilizing CSS frameworks like [TailwindCSS](https://tailwindcss.com/). TailwindCSS generates a global stylesheet based on the utility classes used in your project. Each component exports `class` and `id` props that can be leveraged for this purpose.
-
-## Install
-
-If you haven't used Svelte before, start with the [tutorial](https://svelte.dev/tutorial/basics).
-
-- [SvelteKit](https://kit.svelte.dev)
-- [Astro](https://docs.astro.build/en/tutorial/1-setup/2/)
-- [Vite](https://vitejs.dev/guide/)
-
-```bash
-npm install -D drab
-```
-
-## Documentation
-
-The library provides inline documentation for each component, allowing you to conveniently access the documentation by hovering over the component in your text editor after importing it. Additionally, every prop is documented using JSDoc and TypeScript. By hovering over a prop, you can retrieve its type and description.
-
-These docs use the [TailwindCSS Typography plugin](https://tailwindcss.com/docs/typography-plugin) for base styles along with a few custom utility classes you can find [here](https://github.com/rossrobino/drab/blob/main/src/app.postcss). Styles on this site are based on [shadcn/ui](https://ui.shadcn.com/).
-
-## Alternatives
-
-If **drab** isn't what you are looking for, here are some other Svelte UI libraries to check out.
-
-- [Skeleton](https://skeleton.dev)
-- [Melt UI](https://www.melt-ui.com/)
-- [shadcn-svelte](https://www.shadcn-svelte.com/)
-- [Svelte-HeadlessUI](https://captaincodeman.github.io/svelte-headlessui/)
-
-## Contributing
-
-Find an bug or have an idea? Feel free to create an issue on [GitHub](https://github.com/rossrobino/drab).
-
-Since this is an unstyled library, simple components like a badge that can be easily created with HTML and CSS are not included.
-
-### Local Development
-
-Contribute to the project, or use **drab** as a template for another component library. This library is built with SvelteKit, TypeScript, and npm. The package contents are located in `src/lib`, the site is contained within `src/routes` and `src/site`. The site is deployed to Vercel using `@sveltejs/adapter-vercel`. If you are using this project as a template, be sure to [update the adapter](https://kit.svelte.dev/docs/adapters) based on how you deploy.
-
-#### Make changes
-
-1. Clone the [repository](https://github.com/rossrobino/drab)
-2. `npm install`
-3. `npm run dev -- --open`
-
-#### Add or edit a component
-
-1. Add/edit the component in `src/lib/components/Component.svelte`, if you're adding a new one, copy and paste an existing one to get started with the conventions
-2. Add/edit the example in `src/routes/docs/Component/+page.svelte`
-3. Document the component with an `@component` comment, include a description, and the `@slots` available. Add a placeholder `@props` and `@example` to the comment. These sections will be generated based on the JSDoc comment above each prop and the example route created upon running `npm run doc`
-4. If new, add the link to `src/site/components/NavItems.svelte`
-5. Run `npm run build` to verify your build
+# An Unstyled Svelte Component Library
+
+- [Docs](https://drab.robino.dev)
+- [GitHub](https://github.com/rossrobino/drab)
+- [npm](https://www.npmjs.com/package/drab)
+- [MIT License](https://github.com/rossrobino/drab/blob/main/LICENSE.md)
+
+## About
+
+**drab** focuses on providing JavaScript functionality where it's most useful. Many of the components are helpful wrappers around browser APIs. Whenever possible, components are [progressively enhanced](/docs/ShareButton) or provide a fallback [noscript](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/noscript) message. Additionally, transitions are disabled for users who prefer reduced motion.
+
+This library takes a more opinionated approach compared to some headless UI libraries by providing the basic HTML structure for every component, as well as default positioning for elements like the [sheet](/docs/Sheet). However, these components can still be further customized using styles, [slots](https://svelte.dev/tutorial/slots), and [slot props](https://svelte.dev/tutorial/slot-props).
+
+Components without styles can appear rather drab. You have the freedom to bring your own styles to these components! Using unstyled components allows you to selectively choose what you need, seamlessly integrate with existing designs, and avoid being tied to any specific library.
+
+To style the components, you can make use of [global styles](https://joyofcode.xyz/global-styles-in-sveltekit). Each component exports `class` and `id` props that can be leveraged for this purpose. This process can be expedited by utilizing CSS frameworks like [TailwindCSS](https://tailwindcss.com/). Tailwind generates a global stylesheet based on the utility classes used in your project. The examples in this documentation are styled with Tailwind classes, but Tailwind does not have to be used with this library.
+
+## Install
+
+If you haven't used Svelte before, start with the [tutorial](https://svelte.dev/tutorial/basics). **drab** works anywhere Svelte does.
+
+- [SvelteKit](https://kit.svelte.dev)
+- [Astro](https://docs.astro.build/en/tutorial/1-setup/2/)
+- [Vite](https://vitejs.dev/guide/)
+
+```bash
+npm install -D drab
+```
+
+## Documentation
+
+The library provides inline documentation for each component, allowing you to conveniently access the documentation by hovering over the component in your text editor after importing it. Additionally, every prop is documented using JSDoc and TypeScript. By hovering over a prop, you can retrieve its type and description.
+
+These docs use the [TailwindCSS Typography plugin](https://tailwindcss.com/docs/typography-plugin) for base styles along with a few custom utility classes you can find [here](https://github.com/rossrobino/drab/blob/main/src/app.postcss). Styles on this site are based on [shadcn/ui](https://ui.shadcn.com/).
+
+## Alternatives
+
+If **drab** isn't what you are looking for, here are some other Svelte UI libraries to check out.
+
+- [Skeleton](https://skeleton.dev)
+- [Melt UI](https://www.melt-ui.com/)
+- [shadcn-svelte](https://www.shadcn-svelte.com/)
+- [Svelte-HeadlessUI](https://captaincodeman.github.io/svelte-headlessui/)
+
+## Contributing
+
+Find an bug or have an idea? Feel free to create an issue on [GitHub](https://github.com/rossrobino/drab). **drab** is meant to house all kinds of components including ones outside of the standard UI elements.
+
+Currently, **drab** has only one dependency - Svelte. Not to say it will never have another, but please consider this when adding in additional functionality. **drab** is meant to make the web platform easier to use with Svelte.
+
+Since this is an unstyled library, simple components like a badge that can be easily created with HTML and CSS are not included.
+
+### Local Development
+
+Contribute to the project, or use **drab** as a template for another component library. This library is built with SvelteKit, TypeScript, and npm. The package contents are located in `src/lib`, the site is contained within `src/routes` and `src/site`. The site is deployed to Vercel using `@sveltejs/adapter-vercel`. If you are using this project as a template, be sure to [update the adapter](https://kit.svelte.dev/docs/adapters) based on how you deploy.
+
+#### Make changes
+
+1. Clone the [repository](https://github.com/rossrobino/drab)
+2. `npm install`
+3. `npm run dev -- --open`
+
+#### Add or edit a component
+
+1. Add or edit the component in `src/lib/components/Component.svelte` - if you're adding a new one, copy and paste an existing one to get started with the conventions
+2. Add or edit the example in `src/routes/docs/Component/+page.svelte`
+3. Document the component with an `@component` comment, include a description, and the `@slots` available. Add a placeholder `@props` and `@example` to the comment. These sections will be generated based on the JSDoc comment above each prop and the example route upon running `npm run doc`
+4. If new, add the link to `src/site/components/NavItems.svelte`
+5. Run `npm run build` to verify your build

package/dist/components/Breakpoint.svelte

@@ -16,13 +16,13 @@ With SvelteKit, this component can be wrapped in an `{#if dev}` block that check
 @example
 
 ```svelte
-<script lang="ts">
-	import { Breakpoint } from "drab";
-</script>
-
-<Breakpoint
-	class="inline-block rounded border px-2 py-1 font-mono tabular-nums shadow"
-/>
+<script lang="ts">
+	import { Breakpoint } from "drab";
+</script>
+
+<Breakpoint
+	class="inline-block rounded border bg-white px-2 py-1 font-mono tabular-nums shadow"
+/>
 ```
 -->
 

package/dist/components/Breakpoint.svelte.d.ts

@@ -37,7 +37,7 @@ export type BreakpointSlots = typeof __propDef.slots;
  * </script>
  *
  * <Breakpoint
- * class="inline-block rounded border px-2 py-1 font-mono tabular-nums shadow"
+ * class="inline-block rounded border bg-white px-2 py-1 font-mono tabular-nums shadow"
  * />
  * ```
  */

package/dist/components/ContextMenu.svelte

@@ -1,11 +1,11 @@
-<!--
-@component
-
-### ContextMenu
-
-Displays when the `target` element is right clicked, or long pressed on mobile.
-
-@props
+<!--
+@component
+
+### ContextMenu
+
+Displays when the `target` element is right clicked, or long pressed on mobile.
+
+@props
 
 - `class` 
 - `display` - shows / hides the menu
@@ -13,45 +13,45 @@ Displays when the `target` element is right clicked, or long pressed on mobile.
 - `target` - target element to right click, defaults to the parent element
 - `transition` - scales the menu, set to `false` to disable
 
-@slots
-
-| name       | purpose                         | default value |
-| ---------- | ------------------------------- | ------------- |
-| `default`  | default                         | Context Menu  |
-
-@example
+@slots
+
+| name       | purpose                         | default value |
+| ---------- | ------------------------------- | ------------- |
+| `default`  | default                         | Context Menu  |
+
+@example
 
 ```svelte
-<script lang="ts">
-	import { ContextMenu } from "drab";
-
-	let target: HTMLButtonElement;
-</script>
-
-<div class="mb-8 flex justify-center rounded border border-dashed p-12">
-	<div>Parent right click</div>
-	<ContextMenu>
-		<div class="flex w-48 flex-col gap-2 rounded border bg-white p-2 shadow">
-			<div class="font-bold">Context Menu</div>
-			<button role="menuitem" class="btn">Button</button>
-			<button role="menuitem" class="btn">Button</button>
-			<button role="menuitem" class="btn">Button</button>
-		</div>
-	</ContextMenu>
-</div>
-
-<button type="button" class="btn" bind:this={target}>Target Right Click</button>
-<ContextMenu {target}>
-	<div class="flex w-48 flex-col gap-2 rounded border bg-white p-2 shadow">
-		<div class="font-bold">Context Menu</div>
-		<button role="menuitem" class="btn">Button</button>
-		<button role="menuitem" class="btn">Button</button>
-		<button role="menuitem" class="btn">Button</button>
-	</div>
-</ContextMenu>
+<script lang="ts">
+	import { ContextMenu } from "drab";
+
+	let target: HTMLButtonElement;
+</script>
+
+<div class="mb-8 flex justify-center rounded border border-dashed p-12">
+	<div>Parent right click</div>
+	<ContextMenu>
+		<div class="flex w-48 flex-col gap-2 rounded border bg-white p-2 shadow">
+			<div class="font-bold">Context Menu</div>
+			<button role="menuitem" class="btn">Button</button>
+			<button role="menuitem" class="btn">Button</button>
+			<button role="menuitem" class="btn">Button</button>
+		</div>
+	</ContextMenu>
+</div>
+
+<button type="button" class="btn" bind:this={target}>Target Right Click</button>
+<ContextMenu {target}>
+	<div class="flex w-48 flex-col gap-2 rounded border bg-white p-2 shadow">
+		<div class="font-bold">Target</div>
+		<button role="menuitem" class="btn">Button</button>
+		<button role="menuitem" class="btn">Button</button>
+		<button role="menuitem" class="btn">Button</button>
+	</div>
+</ContextMenu>
 ```
--->
-
+-->
+
 <script>import { onMount, tick } from "svelte";
 import { scale } from "svelte/transition";
 import { duration, start } from "../util/transition";
@@ -116,34 +116,33 @@ onMount(async () => {
     target.addEventListener("touchcancel", onTouchEnd);
   }
 });
-</script>
-
-<svelte:body on:click={hide} on:keydown={onKeyDown} />
-
-<span bind:this={base} role="presentation"></span>
-
-{#if display}
-	<div
-		role="menu"
-		class={className}
-		{id}
-		bind:this={contextMenu}
-		style:top="{coordinates.y}px"
-		style:left="{coordinates.x}px"
-		transition:scale={transition ? transition : { duration: 0 }}
-	>
-		<slot>Context Menu</slot>
-	</div>
-{/if}
-
-<style>
-	span {
-		width: 0;
-		height: 0;
-		opacity: 0;
-	}
-	div {
-		position: absolute;
-		z-index: 10;
-	}
-</style>
+</script>
+
+<svelte:body on:click={hide} on:keydown={onKeyDown} />
+
+<span bind:this={base} role="presentation"></span>
+
+{#if display}
+	<div
+		role="menu"
+		class={className}
+		{id}
+		bind:this={contextMenu}
+		style:top="{coordinates.y}px"
+		style:left="{coordinates.x}px"
+		transition:scale={transition ? transition : { duration: 0 }}
+	>
+		<slot>Context Menu</slot>
+	</div>
+{/if}
+
+<style>
+	span {
+		width: 0;
+		height: 0;
+		opacity: 0;
+	}
+	div {
+		position: absolute;
+	}
+</style>

package/dist/components/ContextMenu.svelte.d.ts

@@ -61,7 +61,7 @@ export type ContextMenuSlots = typeof __propDef.slots;
  * <button type="button" class="btn" bind:this={target}>Target Right Click</button>
  * <ContextMenu {target}>
  * <div class="flex w-48 flex-col gap-2 rounded border bg-white p-2 shadow">
- * 	<div class="font-bold">Context Menu</div>
+ * 	<div class="font-bold">Target</div>
  * 	<button role="menuitem" class="btn">Button</button>
  * 	<button role="menuitem" class="btn">Button</button>
  * 	<button role="menuitem" class="btn">Button</button>

package/dist/components/CopyButton.svelte

@@ -3,14 +3,16 @@
 
 ### CopyButton
 
-Uses the [Clipboard API](https://developer.mozilla.org/en-US/docs/Web/API/Clipboard/writeText) to copy text to the clipboard. If JavaScript is disabled, the button is disabled and `text` is displayed after the button.
+Uses the [Clipboard API](https://developer.mozilla.org/en-US/docs/Web/API/Clipboard) to copy data to the clipboard. Falls back to `writeText` if `write` is not supported and `blob.type` is text. If JavaScript is disabled, the button is disabled and `blobParts.join()` is displayed after the button if `blob.type` is text.
 
 @props
 
+- `blobParts` - array of `BlobParts` to copy - [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Blob/Blob#parameters)
+- `blob` - use a blob in instead of `blobParts` and `options`, defaults to `new Blob(blobParts, options)`
 - `classNoscript` - `noscript` class
 - `class` 
 - `id` 
-- `text` - text to copy
+- `options` - defaults to `{ type: "text/plain" }` - [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Blob/Blob#parameters)
 - `title` 
 
 @slots
@@ -23,11 +25,11 @@ Uses the [Clipboard API](https://developer.mozilla.org/en-US/docs/Web/API/Clipbo
 @example
 
 ```svelte
-<script lang="ts">
-	import { CopyButton } from "drab";
-</script>
-
-<CopyButton class="btn" text="Text to copy" />
+<script lang="ts">
+	import { CopyButton } from "drab";
+</script>
+
+<CopyButton class="btn" blobParts={["Text to copy"]} />
 ```
 -->
 
@@ -37,25 +39,41 @@ let className = "";
 export { className as class };
 export let id = "";
 export let title = "";
-export let text;
+export let options = { type: "text/plain" };
+export let blobParts = void 0;
+export let blob = new Blob(blobParts, options);
 export let classNoscript = "";
-let clientJs = false;
+let disabled = true;
 let complete = false;
+const writeSupport = () => "write" in navigator.clipboard;
+const typeText = blob.type.startsWith("text");
+const canWriteText = () => {
+  const writeTextSupport = "writeText" in navigator.clipboard;
+  return writeTextSupport && typeText;
+};
 const copyText = async () => {
   try {
-    await navigator.clipboard.writeText(text);
+    if (writeSupport()) {
+      const data = [new ClipboardItem({ [blob.type]: blob })];
+      await navigator.clipboard.write(data);
+    } else if (canWriteText()) {
+      await navigator.clipboard.writeText(blobParts ? blobParts.join() : "");
+    }
     complete = true;
     setTimeout(() => complete = false, delay);
   } catch (error) {
     console.error(error);
   }
 };
-onMount(() => clientJs = true);
+onMount(() => {
+  if (writeSupport() || canWriteText())
+    disabled = false;
+});
 </script>
 
 <button
 	type="button"
-	disabled={!clientJs}
+	{disabled}
 	on:click={copyText}
 	class={className}
 	{id}
@@ -68,4 +86,8 @@ onMount(() => clientJs = true);
 	{/if}
 </button>
 
-<noscript><span class={classNoscript}>{text}</span></noscript>
+{#if typeText}
+	<noscript>
+		<span class={classNoscript}>{blobParts ? blobParts.join() : ""}</span>
+	</noscript>
+{/if}

package/dist/components/CopyButton.svelte.d.ts

@@ -4,7 +4,9 @@ declare const __propDef: {
         class?: string | undefined;
         id?: string | undefined;
         title?: string | undefined;
-        /** text to copy */ text: string;
+        /** defaults to `{ type: "text/plain" }` - [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Blob/Blob#parameters) */ options?: BlobPropertyBag | undefined;
+        /** array of `BlobParts` to copy - [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Blob/Blob#parameters) */ blobParts?: BlobPart[] | undefined;
+        /** use a blob in instead of `blobParts` and `options`, defaults to `new Blob(blobParts, options)` */ blob?: Blob | undefined;
         /** `noscript` class */ classNoscript?: string | undefined;
     };
     events: {
@@ -21,14 +23,16 @@ export type CopyButtonSlots = typeof __propDef.slots;
 /**
  * ### CopyButton
  *
- * Uses the [Clipboard API](https://developer.mozilla.org/en-US/docs/Web/API/Clipboard/writeText) to copy text to the clipboard. If JavaScript is disabled, the button is disabled and `text` is displayed after the button.
+ * Uses the [Clipboard API](https://developer.mozilla.org/en-US/docs/Web/API/Clipboard) to copy data to the clipboard. Falls back to `writeText` if `write` is not supported and `blob.type` is text. If JavaScript is disabled, the button is disabled and `blobParts.join()` is displayed after the button if `blob.type` is text.
  *
  * @props
  *
+ * - `blobParts` - array of `BlobParts` to copy - [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Blob/Blob#parameters)
+ * - `blob` - use a blob in instead of `blobParts` and `options`, defaults to `new Blob(blobParts, options)`
  * - `classNoscript` - `noscript` class
  * - `class`
  * - `id`
- * - `text` - text to copy
+ * - `options` - defaults to `{ type: "text/plain" }` - [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Blob/Blob#parameters)
  * - `title`
  *
  * @slots
@@ -45,7 +49,7 @@ export type CopyButtonSlots = typeof __propDef.slots;
  * import { CopyButton } from "drab";
  * </script>
  *
- * <CopyButton class="btn" text="Text to copy" />
+ * <CopyButton class="btn" blobParts={["Text to copy"]} />
  * ```
  */
 export default class CopyButton extends SvelteComponent<CopyButtonProps, CopyButtonEvents, CopyButtonSlots> {