@turnipxenon/pineapple 2.4.13 → 2.4.14

package/dist/components/pineapple/toast/Toast.svelte

@@ -0,0 +1,89 @@
+<script>import {
+  activeToast,
+  DefaultToastParamsDuration,
+  toastQueue
+} from "./Toast";
+import {} from "svelte";
+import Card from "../../Card.svelte";
+import { spring, tweened } from "svelte/motion";
+let localComponent;
+let localProps;
+const HIDDEN_VALUE = -15;
+const SHOWN_VALUE = 0;
+const progress = tweened(0, { duration: DefaultToastParamsDuration });
+const position = spring(HIDDEN_VALUE);
+position.damping = 0.4;
+let isDismissed = false;
+let shouldEnableButton = false;
+const onToastDisappear = () => {
+  localComponent = void 0;
+  activeToast.update(() => {
+    if (toastQueue.length === 0) {
+      return void 0;
+    }
+    return toastQueue.shift();
+  });
+};
+activeToast.subscribe((params) => {
+  if (!params) {
+    return;
+  }
+  if (params.componentAndProps?.component === localComponent) {
+    return;
+  }
+  localComponent = params.componentAndProps.component;
+  localProps = params.componentAndProps.props;
+  progress.set(0, { duration: 0 }).then(() => {
+    position.set(SHOWN_VALUE).then(() => {
+      shouldEnableButton = true;
+      progress.set(100, { delay: 500, duration: params.duration ?? DefaultToastParamsDuration }).then(() => {
+        shouldEnableButton = false;
+        if (isDismissed) {
+          return;
+        }
+        position.set(HIDDEN_VALUE).then(onToastDisappear);
+      });
+    });
+  });
+});
+const dismissToast = () => {
+  shouldEnableButton = false;
+  isDismissed = true;
+  position.set(HIDDEN_VALUE).then(onToastDisappear);
+};
+</script>
+
+{#if (localComponent !== undefined)}
+	<div class="toast-positioner" style={`bottom: ${$position}lh;`}>
+		<!-- todo: adjust shadow to be more dynamic or transparent -->
+		<Card marginBottom="1lh" overrideStyle="box-shadow: 3px 3px 3px var(--shadow-color);">
+			<div slot="content">
+				{#if (localProps !== undefined)}
+					<svelte:component this={localComponent}
+					                  props={localProps}
+					                  dismissToastCallback={dismissToast}
+					                  shouldEnableButton={shouldEnableButton} />
+				{:else }
+					<svelte:component this={localComponent} />
+				{/if}
+				<progress id="toast-progress" value={$progress/100}></progress>
+			</div>
+		</Card>
+	</div>
+{/if}
+
+<style>
+    .toast-positioner {
+        position: fixed;
+        /* 12em = this component's margin (4em) + fab margin + width (8em) */
+        max-width: calc(100vw - 12em);
+    }
+
+    .toast-positioner:dir(ltr) {
+        left: 2em;
+    }
+
+    .toast-positioner:dir(rtl) {
+        right: 2em;
+    }
+</style>

package/dist/components/pineapple/toast/Toast.svelte.d.ts

@@ -0,0 +1,14 @@
+import { SvelteComponent } from "svelte";
+declare const __propDef: {
+    props: Record<string, never>;
+    events: {
+        [evt: string]: CustomEvent<any>;
+    };
+    slots: {};
+};
+export type ToastProps = typeof __propDef.props;
+export type ToastEvents = typeof __propDef.events;
+export type ToastSlots = typeof __propDef.slots;
+export default class Toast extends SvelteComponent<ToastProps, ToastEvents, ToastSlots> {
+}
+export {};

package/dist/components/pineapple/toast/custom-toast/TestCustomToast.d.ts

@@ -0,0 +1,5 @@
+import TestCustomToast from "./TestCustomToast.svelte";
+export interface TestCustomToastPair {
+    component: typeof TestCustomToast;
+    props: undefined;
+}

package/dist/components/pineapple/toast/custom-toast/TestCustomToast.js

@@ -0,0 +1 @@
+import TestCustomToast from "./TestCustomToast.svelte";

package/dist/components/pineapple/toast/custom-toast/TestCustomToast.svelte

@@ -0,0 +1 @@
+<h1>Testing bad custom card</h1>

package/dist/components/pineapple/toast/custom-toast/TestCustomToast.svelte.d.ts

@@ -0,0 +1,23 @@
+/** @typedef {typeof __propDef.props}  TestCustomToastProps */
+/** @typedef {typeof __propDef.events}  TestCustomToastEvents */
+/** @typedef {typeof __propDef.slots}  TestCustomToastSlots */
+export default class TestCustomToast extends SvelteComponent<{
+    [x: string]: never;
+}, {
+    [evt: string]: CustomEvent<any>;
+}, {}> {
+}
+export type TestCustomToastProps = typeof __propDef.props;
+export type TestCustomToastEvents = typeof __propDef.events;
+export type TestCustomToastSlots = typeof __propDef.slots;
+import { SvelteComponent } from "svelte";
+declare const __propDef: {
+    props: {
+        [x: string]: never;
+    };
+    events: {
+        [evt: string]: CustomEvent<any>;
+    };
+    slots: {};
+};
+export {};

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export { default as PineappleLayoutBase } from "./components/layouts/PineappleBaseLayout.svelte";
+export { default as PineappleLayoutBase } from "./components/pineapple/PineappleBaseLayout.svelte";
 export { default as SeaweedTemplate } from "./template/SeaweedTemplate.svelte";
 export { default as LazyAsset } from "./components/LazyAsset.svelte";
 export * from "./components/dialog_manager/DialogManagerStore";

package/dist/index.js

@@ -1,4 +1,4 @@
-export { default as PineappleLayoutBase } from "./components/layouts/PineappleBaseLayout.svelte";
+export { default as PineappleLayoutBase } from "./components/pineapple/PineappleBaseLayout.svelte";
 export { default as SeaweedTemplate } from "./template/SeaweedTemplate.svelte";
 export { default as LazyAsset } from "./components/LazyAsset.svelte";
 export * from "./components/dialog_manager/DialogManagerStore";

package/docs/OverlaySpec.md

@@ -0,0 +1,23 @@
+# Overlay Spec
+
+**What are the things that can appear on top of the normal content?**
+
+- Toast
+- Modal
+- Dialog
+  - Choices
+- Backstage
+  - Preferences
+  - Optional: Dialog??
+
+**Which one appears on top?**
+
+- Toast
+- Modal
+  - blocks access on anything below
+- Backstage
+  - blocks access on anything below
+- Dialog: choices
+  - blocks access on anything below
+- Dialog
+- Everything else

package/docs/pull_request_template.md

@@ -0,0 +1,34 @@
+## Which issues does this affect?
+
+- Closes #*PR number*
+
+## Overview
+
+*Insert brief description here*
+
+## Description
+
+*If there are more details or more things that needs to be talked about, put it here.*
+
+## Checks
+
+- [ ] If some of the checks below are deferred, link an issue for it under as a child
+
+### Accessibility
+
+- [ ] [Changes are keyboard accessible](https://accessibility.18f.gov/keyboard/)
+- [ ] [All form inputs have explicit labels](https://accessibility.18f.gov/forms/)
+- [ ] [Page content has a meaningful heading hierarchy](https://accessibility.18f.gov/headings/)
+- [ ] [All relevant images use an img tag and have alt attributes](https://accessibility.18f.gov/images/)
+- [ ] [Text has sufficient color contrast](https://accessibility.18f.gov/color/) (a contrast ratio of 4.5:1 with the
+  background)
+- [ ] [No red flags when running WAVE on the page](http://wave.webaim.org/)
+- [ ] The UI should also work in left-to-right direction
+
+For the full list, see [18F's Accessibility Checklist](https://accessibility.18f.gov/checklist/).
+
+
+<!--
+References:
+- https://github.com/ministryofjustice/accessibility-checklist/blob/master/README.md
+-->

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@turnipxenon/pineapple",
   "description": "personal package for base styling for other personal projects",
-  "version": "2.4.13",
+  "version": "2.4.14",
   "scripts": {
     "dev": "vite dev",
     "build": "npm run check-requirements && vite build && yarn package",

package/src/lib/app.postcss

@@ -41,11 +41,11 @@ html, body {
 }
 
 /* todo: add some hues to the icon that should be in sync with primary and make them not pure darkness */
-.turnip-button > img {
+.turnip-button > img, .img-icon {
     filter: grayscale(100%) brightness(0%) invert(25%);
 }
 
-.dark .turnip-button > img {
+.dark .turnip-button > img, .dark .img-icon {
     filter: grayscale(100%) brightness(0%) invert(100%);
 }
 
@@ -164,4 +164,30 @@ a:active {
 .accordion-item {
     @apply variant-filled-primary rounded-md;
 }
+
 /* endregion Accordion css for handling missing styles in package */
+
+:root {
+    --shadow-color: rgba(91, 79, 54, 0.5);
+}
+
+/* todo: adjust shadow for each component + change depending on dark mode or not */
+.fab, #shell-header {
+    box-shadow: 3px 3px 3px var(--shadow-color);
+}
+
+#toast-progress {
+    position: relative;
+    top: 5px;
+    left: 6px;
+    width: calc(100% - 12px);
+    border-radius: 8px;
+    background: transparent;
+    height: 10px;
+}
+
+#toast-progress::-moz-progress-bar {
+    /*background-color: red;*/
+    background: rgba(var(--color-secondary-500));
+}
+

package/src/lib/assets/icons/close.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" height="24" viewBox="0 -960 960 960" width="24"><path d="m256-200-56-56 224-224-224-224 56-56 224 224 224-224 56 56-224 224 224 224-56 56-224-224-224 224Z"/></svg>

package/src/lib/components/Card.svelte

@@ -1,6 +1,6 @@
 <script lang="ts">
 	export let margin = "0";
-	export let marginBottom = "3em";
+	export let marginBottom = "2lh";
 	export let overrideStyle = "";
 	export let includeDataNoSnippet = true;
 

package/src/lib/components/Chip.svelte

@@ -8,5 +8,6 @@
         margin: 0.25em;
         font-weight: bold;
         pointer-events: none;
+        background-color: rgb(var(--color-tertiary-500) / var(--tw-bg-opacity));
     }
 </style>

package/src/lib/components/pineapple/PineappleBaseLayout.svelte

@@ -0,0 +1,207 @@
+<script lang="ts">
+	// For auto dark/light mode
+	import { AppBar, AppShell, autoModeWatcher, LightSwitch } from "@skeletonlabs/skeleton";
+	import RandomizedBackground from "$pkg/components/RandomizedBackground.svelte";
+
+	// navigation
+	import { page } from "$app/stores";
+	// store
+	import { enableBackground } from "$pkg/store";
+	import type { BreadcrumbData } from "$pkg/types/BreadcrumbData";
+	// assets
+	// import DialogOverlay from "$lib/components/DialogOverlay.svelte";
+	import AresLogo from "$pkg/assets/characters/ares/ares_logo.webp";
+	import FABIcon from "$pkg/assets/placeholder/placeholder_circle.png";
+	import { enableDialogueOverlay } from "$pkg/components/dialog_manager/DialogManagerStore";
+	import Toast from "$pkg/components/pineapple/toast/Toast.svelte";
+	// todo: clean up all these imports!
+
+	let pages: BreadcrumbData[] = [];
+
+	const updateBreadcrumb = (pathname: string) => {
+		pages = [];
+		let basePath = "";
+		pathname.split("/").forEach((value, index) => {
+			if (index === 0) {
+				basePath = "/";
+				pages.push({
+					path: "/",
+					name: "Home"
+				});
+				return;
+			}
+
+			if (value === "") {
+				return;
+			}
+
+			basePath += value + "/";
+			pages.push({
+				path: basePath,
+				name: value
+			});
+		});
+		pages = pages;
+	};
+
+	$: updateBreadcrumb($page.url.pathname); // run every time we navigate
+
+	let enableBackgroundValue = true;
+	enableBackground.subscribe((value) => {
+		enableBackgroundValue = value;
+	});
+
+	let enableDialogueOverlayValue = true;
+	enableDialogueOverlay.subscribe((value) => {
+		enableDialogueOverlayValue = value;
+	});
+</script>
+
+<!-- App Shell -->
+<svelte:head>
+	{@html `<script>${autoModeWatcher.toString()} autoModeWatcher();</script>`}
+</svelte:head>
+
+<!--todo: turn off hidden when it's time-->
+<button type="button" class="fab" on:click={()=>{
+    enableDialogueOverlay.set(!enableDialogueOverlayValue);
+}}>
+	<img src={FABIcon} alt="interactive floating action button represented as a turnip">
+</button>
+
+<AppShell>
+	<svelte:fragment slot="header">
+		<!-- App Bar -->
+		<AppBar
+			background="app-shell-token"
+			slotDefault="place-content-start"
+			slotTrail="place-content-end">
+			<svelte:fragment slot="lead">
+				<!--TODO: add logo or something for the lead in layout-->
+				<img
+					alt="Ares's head titled towards the left with his tongue out and winking"
+					class="ares-logo"
+					src={AresLogo}
+				/>
+				<span class="mr-2" />
+				<ol class="breadcrumb">
+					{#each pages as crumb, i}
+						{#if i < pages.length - 1}
+							<li class="crumb">
+								<a href={crumb.path}>{crumb.name.charAt(0).toUpperCase() + crumb.name.slice(1)}</a>
+							</li>
+							<li class="crumb-separator" aria-hidden="true">&rsaquo;</li>
+						{:else}
+							<li class="crumb">{crumb.name.charAt(0).toUpperCase() + crumb.name.slice(1)}</li>
+						{/if}
+					{/each}
+				</ol>
+			</svelte:fragment>
+			<svelte:fragment slot="trail">
+				<LightSwitch bgLight="bg-surface-400" />
+			</svelte:fragment>
+		</AppBar>
+	</svelte:fragment>
+
+	<RandomizedBackground enable={enableBackgroundValue} />
+
+	<Toast></Toast>
+
+	<div class="default-page-container">
+		<slot />
+		<div class="footer-space" />
+	</div>
+	<!--{#if enableDialogueOverlayValue}-->
+	<!--	&lt;!&ndash; Page Route Content &ndash;&gt;-->
+	<!--	<div class="default-page-container">-->
+	<!--		<slot />-->
+	<!--		<div class="footer-space" />-->
+	<!--	</div>-->
+	<!--	<DialogOverlay />-->
+	<!--{:else}-->
+	<!--	<DialogOverlay />-->
+	<!--	<slot />-->
+	<!--{/if}-->
+</AppShell>
+
+<style lang="postcss">
+    :root {
+        --dialog-left-pad: clamp(0em, 5vw, 2em);
+        --dialog-box-width: min(calc(50em + 4em), calc(100vw - var(--dialog-left-pad) - var(--theme-border-base)));
+        --dialog-box-height: clamp(15em, 50vw, 18em);
+
+        /** FAB icon margin/position calculation origin:
+						Criteria:
+						- We want at mobile (360px) our margin to be at 1em (16px)
+						- We want at web (1960px) our margin to be at 2em (32px)
+
+						A useful scaling factor might vw. At 360px, 16px would be around 4.44vw (360/16).
+						At 360px: margin is at 16px or 1em.
+						At 1960px: 4.44vw is at 87px but that will be clamped to 32px or 2em.
+						The calculation implies that the natural point that the margin becomes 2em is clamped on
+						wider screens is at 727px.
+				*/
+        --fab-margin: clamp(1em, 4.44vw, 2em);
+    }
+
+    .default-page-container {
+        @apply flex justify-center items-center;
+        margin-top: 4em;
+        margin-left: clamp(1em, 15vw, 10em);
+        margin-right: 1em;
+        flex-direction: column;
+        z-index: 0;
+    }
+
+    .ares-logo {
+        object-fit: contain;
+        height: 2em;
+        margin-inline-end: 0.5em;
+    }
+
+    /* breadcrumb does not work due to a lot of magic stuff i do
+       the code below is from skeleton's tailwind css:
+       https://github.com/skeletonlabs/skeleton/blob/54f4ecedabf2be6d94a670b56dc8821095ca3fc9/packages/plugin/src/styles/components/breadcrumbs.css
+
+       it likely disappeared due to code gen shenanigans and package magic */
+    .breadcrumb,
+    .breadcrumb-nonresponsive {
+        @apply flex items-center space-x-4 w-full overflow-x-auto;
+        /*@apply flex items-center space-x-4 w-full hide-scrollbar overflow-x-auto;*/
+    }
+
+    .crumb {
+        @apply flex justify-center items-center space-x-2;
+    }
+
+    .crumb-separator {
+        @apply flex text-surface-700-200-token opacity-50;
+    }
+
+    /* === Auto-Responsive === */
+
+    .breadcrumb li {
+        @apply hidden md:block;
+    }
+
+    .breadcrumb li:nth-last-child(3),
+    .breadcrumb li:nth-last-child(2),
+    .breadcrumb li:nth-last-child(1) {
+        @apply block;
+    }
+
+    .fab {
+        position: fixed;
+        bottom: var(--fab-margin);
+        width: 4em;
+        border-radius: 50%;
+    }
+
+    .fab:dir(ltr) {
+        right: var(--fab-margin);
+    }
+
+    .fab:dir(rtl) {
+        left: var(--fab-margin);
+    }
+</style>

package/src/lib/components/pineapple/toast/DefaultToastBody.svelte

@@ -0,0 +1,43 @@
+<script lang="ts">
+	import type { Props } from "$pkg/components/pineapple/toast/DefaultToastBody";
+	import type { DismissToastCallback } from "$pkg/components/pineapple/toast/Toast";
+	import CloseIcon from "$pkg/assets/icons/close.svg";
+
+	export let props: Props;
+	export let dismissToastCallback: DismissToastCallback | undefined;
+	export let shouldEnableButton = false;
+</script>
+
+<div class="body-container">
+	<!-- todo: support markdown? -->
+	<button class="btn"
+	        disabled={!shouldEnableButton}
+	        on:click={dismissToastCallback}>
+		<img class="img-icon" src={CloseIcon} alt="close button">
+	</button>
+	<div class="text-container">
+		<span>{props.message}</span>
+	</div>
+</div>
+
+<style lang="postcss">
+    .body-container {
+        display: flex;
+        gap: 1em;
+    }
+
+    .text-container {
+        margin-top: 0.25lh;
+        margin-right: 1em;
+    }
+
+    .text-container:dir(rtl) {
+        margin-left: 1em;
+    }
+
+    .btn {
+        @apply bg-surface-100 dark:bg-surface-900;
+        border-radius: 8px;
+		    padding: 0.5em;
+    }
+</style>

package/src/lib/components/pineapple/toast/DefaultToastBody.ts

@@ -0,0 +1,10 @@
+import DefaultToastBody from "./DefaultToastBody.svelte";
+
+export interface Props {
+	message: string;
+}
+
+export interface DefaultToastPair {
+	component: typeof DefaultToastBody;
+	props: Props;
+}

package/src/lib/components/pineapple/toast/Toast.svelte

@@ -0,0 +1,113 @@
+<script lang="ts">
+	import {
+		activeToast,
+		type CustomToastPairs,
+		DefaultToastParamsDuration,
+		toastQueue
+	} from "$pkg/components/pineapple/toast/Toast";
+	import { type ComponentType } from "svelte";
+	import Card from "$pkg/components/Card.svelte";
+	import { spring, tweened } from "svelte/motion";
+
+	let localComponent: ComponentType | undefined;
+	let localProps: CustomToastPairs["props"];
+
+	// todo: make hidden value reliant on current vh
+	const HIDDEN_VALUE = -15;
+	const SHOWN_VALUE = 0;
+	const progress = tweened(0, { duration: DefaultToastParamsDuration });
+	const position = spring(HIDDEN_VALUE);
+	position.damping = 0.4;
+	let isDismissed = false;
+	let shouldEnableButton = false;
+
+	const onToastDisappear = () => {
+		// clear the local component to undefined to make the component disappear
+		// also set activeToast to null to indicate to the system that it's ready to take new
+		// Toast requests
+		localComponent = undefined;
+		activeToast.update(() => {
+			if (toastQueue.length === 0) {
+				return undefined;
+			}
+			return toastQueue.shift();
+		});
+	};
+
+	activeToast.subscribe((params) => {
+		if (!params) {
+			return;
+		}
+
+		if (params.componentAndProps?.component === localComponent) {
+			return;
+		}
+
+		localComponent = params.componentAndProps.component;
+		localProps = params.componentAndProps.props;
+
+		// todo: make unnested
+		// set progress to 0 before showing
+		progress.set(0, { duration: 0 }).then(() => {
+			// animate showing the toast
+			position.set(SHOWN_VALUE).then(() => {
+				shouldEnableButton = true;
+
+				// now animate the lifespan of the current toast
+				progress.set(100, { delay: 500, duration: params.duration ?? DefaultToastParamsDuration }).then(() => {
+					// during the lifecycle the button to cause dismissal can only happen when
+					// position is completely set SHOWN_VALUE and when progress has reached to 100
+					shouldEnableButton = false;
+					if (isDismissed) {
+						return;
+					}
+
+					// when the lifespan duration is over, animate hiding the toast by putting its bottom
+					// position out of bounds
+					position.set(HIDDEN_VALUE).then(onToastDisappear);
+				});
+			});
+		});
+	});
+
+	const dismissToast = () => {
+		shouldEnableButton = false;
+		isDismissed = true;
+		position.set(HIDDEN_VALUE).then(onToastDisappear);
+	};
+</script>
+
+{#if (localComponent !== undefined)}
+	<div class="toast-positioner" style={`bottom: ${$position}lh;`}>
+		<!-- todo: adjust shadow to be more dynamic or transparent -->
+		<Card marginBottom="1lh" overrideStyle="box-shadow: 3px 3px 3px var(--shadow-color);">
+			<div slot="content">
+				{#if (localProps !== undefined)}
+					<svelte:component this={localComponent}
+					                  props={localProps}
+					                  dismissToastCallback={dismissToast}
+					                  shouldEnableButton={shouldEnableButton} />
+				{:else }
+					<svelte:component this={localComponent} />
+				{/if}
+				<progress id="toast-progress" value={$progress/100}></progress>
+			</div>
+		</Card>
+	</div>
+{/if}
+
+<style lang="postcss">
+    .toast-positioner {
+        position: fixed;
+        /* 12em = this component's margin (4em) + fab margin + width (8em) */
+        max-width: calc(100vw - 12em);
+    }
+
+    .toast-positioner:dir(ltr) {
+        left: 2em;
+    }
+
+    .toast-positioner:dir(rtl) {
+        right: 2em;
+    }
+</style>