@budibase/bbui 1.3.0 → 1.3.3

package/src/Modal/Modal.svelte

@@ -0,0 +1,165 @@
+<script>
+  import "@spectrum-css/modal/dist/index-vars.css"
+  import "@spectrum-css/underlay/dist/index-vars.css"
+  import { createEventDispatcher, setContext, tick } from "svelte"
+  import { fade, fly } from "svelte/transition"
+  import Portal from "svelte-portal"
+  import Context from "../context"
+
+  export let fixed = false
+  export let inline = false
+
+  const dispatch = createEventDispatcher()
+  let visible = fixed || inline
+  let modal
+
+  $: dispatch(visible ? "show" : "hide")
+
+  export function show() {
+    if (visible) {
+      return
+    }
+    visible = true
+  }
+
+  export function hide() {
+    if (!visible || fixed || inline) {
+      return
+    }
+    visible = false
+  }
+
+  export function cancel() {
+    if (!visible) {
+      return
+    }
+    dispatch("cancel")
+    hide()
+  }
+
+  function handleKey(e) {
+    if (visible && e.key === "Escape") {
+      cancel()
+    }
+  }
+
+  async function focusModal(node) {
+    await tick()
+
+    // Try to focus first input
+    const inputs = node.querySelectorAll("input")
+    if (inputs?.length) {
+      inputs[0].focus()
+    }
+
+    // Otherwise try to focus confirmation button
+    else if (modal) {
+      const confirm = modal.querySelector(".confirm-wrap .spectrum-Button")
+      if (confirm) {
+        confirm.focus()
+      }
+    }
+  }
+
+  setContext(Context.Modal, { show, hide, cancel })
+</script>
+
+<svelte:window on:keydown={handleKey} />
+
+{#if inline}
+  {#if visible}
+    <div use:focusModal bind:this={modal} class="spectrum-Modal inline is-open">
+      <slot />
+    </div>
+  {/if}
+{:else}
+  <!--
+    We cannot conditionally render the portal as this leads to a missing
+    insertion point when using nested modals. Therefore we just conditionally
+    render the content of the portal.
+    It still breaks the modal animation, but its better than soft bricking the
+    screen.
+  -->
+  <Portal target=".modal-container">
+    {#if visible}
+      <div class="spectrum-Underlay is-open" on:mousedown|self={cancel}>
+        <div
+          class="background"
+          in:fade={{ duration: 200 }}
+          out:fade|local={{ duration: 200 }}
+        />
+        <div class="modal-wrapper" on:mousedown|self={cancel}>
+          <div class="modal-inner-wrapper" on:mousedown|self={cancel}>
+            <slot name="outside" />
+            <div
+              use:focusModal
+              bind:this={modal}
+              class="spectrum-Modal is-open"
+              in:fly={{ y: 30, duration: 200 }}
+              out:fly|local={{ y: 30, duration: 200 }}
+            >
+              <slot />
+            </div>
+          </div>
+        </div>
+      </div>
+    {/if}
+  </Portal>
+{/if}
+
+<style>
+  .spectrum-Underlay {
+    display: flex;
+    flex-direction: row;
+    justify-content: center;
+    align-items: center;
+    z-index: 999;
+    overflow: auto;
+    overflow-x: hidden;
+    background: transparent;
+  }
+  .background {
+    background: var(--modal-background, rgba(0, 0, 0, 0.75));
+    position: fixed;
+    top: 0;
+    left: 0;
+    height: 100vh;
+    width: 100vw;
+    opacity: 0.65;
+    pointer-events: none;
+  }
+
+  .modal-wrapper {
+    flex: 1 1 auto;
+    display: flex;
+    flex-direction: row;
+    -moz-box-pack: center;
+    justify-content: center;
+    align-items: flex-start;
+    max-height: 100%;
+  }
+  .modal-inner-wrapper {
+    flex: 1 1 auto;
+    display: flex;
+    flex-direction: row;
+    -moz-box-pack: center;
+    justify-content: center;
+    align-items: flex-start;
+    width: 0;
+    position: relative;
+  }
+
+  .spectrum-Modal {
+    overflow: visible;
+    max-height: none;
+    margin: 40px 0;
+    transform: none;
+    --spectrum-dialog-confirm-border-radius: var(
+      --spectrum-global-dimension-size-100
+    );
+    max-width: 100%;
+  }
+  :global(.spectrum--lightest .spectrum-Modal.inline) {
+    border: var(--border-light);
+  }
+</style>

package/src/Modal/Modal.svench

@@ -0,0 +1,117 @@
+<script>
+  import { View } from "svench";
+  import Modal from "./Modal.svelte";
+  import ModalContent from "./ModalContent.svelte";
+  import Button from "../Button/Button.svelte";
+  import Content from "./Content.svelte";
+  import QuizModal from "./QuizModal.svelte";
+  import CustomContent from "./CustomContent.svelte";
+
+  let modal1
+  let modal2
+  let modal3
+
+  const sleep = ms => new Promise(resolve => setTimeout(resolve, ms))
+  async function longTask() {
+    await sleep(3000)
+  }
+</script>
+
+<style>
+  p, span {
+    font-family: var(--font-sans);
+    font-size: var(--font-size-s);
+  }
+
+  code {
+    display: inline-block;
+    box-sizing: border-box;
+    padding: var(--spacing-xs) var(--spacing-s);
+    background-color: var(--grey-2);
+    color: var(--red-dark);
+    border-radius: var(--spacing-xs);
+  }
+</style>
+
+<h3>Modals</h3>
+<p>
+  Modals provide a means to render content in front of everything else on a page.
+</p>
+<p>
+  The modal module in BBUI exposes two
+  separate components to provide this functionality; a <code>Modal</code> component to control visibility of content,
+  and a <code>ModalContent</code> component to quickly construct the typical content - although this is optional.
+</p>
+<p>
+  One of the common problems with modals and popups is stale state reappearing after hiding and showing the content
+  again, since the state hasn't been garbage collected if a component controls its own visibility. This is handled for
+  you when using the <code>Modal</code> component as it will fully unmount child components, properly resetting state
+  every time it appears.
+</p>
+
+<br/>
+<p>Use ModalContent to render typical modal content.</p>
+<View name="Simple Confirmation Modal">
+  <Button primary on:click={modal1.show}>Delete Record</Button>
+  <Modal bind:this={modal1}>
+    <ModalContent title="Confirm Deletion" confirmText="Delete">
+      <span>Are you sure you want to delete this record?</span>
+    </ModalContent>
+  </Modal>
+</View>
+
+<br/>
+<p>
+  Width can be specified as a prop to a <code>Modal</code>. Any additional <code>ModalContent</code> props provided
+  will be passed to the confirmation button.
+</p>
+<View name="Different Buttons and Width">
+  <Button primary on:click={modal3.show}>Open Modal</Button>
+  <Modal bind:this={modal3} width="250px">
+    <ModalContent
+      title="Confirmation Required"
+      showCancelButton={false}
+      showCloseIcon={false}
+      confirmText="I'm sure!"
+      green
+      large
+      wide
+    >
+      <span>Are you sure you want to do that?</span>
+    </ModalContent>
+  </Modal>
+</View>
+
+<br/>
+<p>Any content can be rendered inside a <code>Modal</code>. Use context to close the modal from your own components.</p>
+<View name="Custom Content">
+  <Button primary on:click={modal1.show}>Open Modal</Button>
+  <Modal bind:this={modal1} padding={false} border={false}>
+    <CustomContent/>
+  </Modal>
+</View>
+
+<br/>
+<p>Async functions passed in as the onConfirm prop will make the modal wait until the callback is completed.</p>
+<View name="Async Callbacks">
+  <Button primary on:click={modal2.show}>Long Task</Button>
+  <Modal bind:this={modal2}>
+    <ModalContent
+      title="Perform Long Task"
+      confirmText="Submit"
+      onConfirm={longTask}
+    >
+      <span>Pressing submit will wait 3 seconds before finishing and disable the confirm button until it's done.</span>
+    </ModalContent>
+  </Modal>
+</View>
+
+<br/>
+<p>Returning false from a onConfirm callback will prevent the modal being closed.</p>
+<View name="Callback Failure Handling">
+  <Button primary on:click={modal3.show}>Open Quiz</Button>
+  <Modal bind:this={modal3}>
+    <QuizModal />
+  </Modal>
+</View>
+

package/src/Modal/ModalContent.svelte

@@ -0,0 +1,192 @@
+<script>
+  import "@spectrum-css/dialog/dist/index-vars.css"
+  import { getContext } from "svelte"
+  import Button from "../Button/Button.svelte"
+  import Divider from "../Divider/Divider.svelte"
+  import Icon from "../Icon/Icon.svelte"
+  import Context from "../context"
+  import ProgressCircle from "../ProgressCircle/ProgressCircle.svelte"
+
+  export let title = undefined
+  export let size = "S"
+  export let cancelText = "Cancel"
+  export let confirmText = "Confirm"
+  export let showCancelButton = true
+  export let showConfirmButton = true
+  export let showCloseIcon = true
+  export let onConfirm = undefined
+  export let onCancel = undefined
+  export let disabled = false
+  export let showDivider = true
+
+  export let showSecondaryButton = false
+  export let secondaryButtonText = undefined
+  export let secondaryAction = undefined
+  export let secondaryButtonWarning = false
+  export let dataCy = null
+
+  const { hide, cancel } = getContext(Context.Modal)
+  let loading = false
+  $: confirmDisabled = disabled || loading
+
+  async function secondary() {
+    loading = true
+    if (!secondaryAction || (await secondaryAction()) !== false) {
+      hide()
+    }
+    loading = false
+  }
+
+  async function confirm() {
+    loading = true
+    if (!onConfirm || (await onConfirm()) !== false) {
+      hide()
+    }
+    loading = false
+  }
+
+  async function close() {
+    loading = true
+    if (!onCancel || (await onCancel()) !== false) {
+      cancel()
+    }
+    loading = false
+  }
+</script>
+
+<div
+  class="spectrum-Dialog"
+  class:spectrum-Dialog--small={size === "S"}
+  class:spectrum-Dialog--medium={size === "M"}
+  class:spectrum-Dialog--large={size === "L"}
+  class:spectrum-Dialog--extraLarge={size === "XL"}
+  style="position: relative;"
+  role="dialog"
+  tabindex="-1"
+  aria-modal="true"
+  data-cy={dataCy}
+>
+  <div class="spectrum-Dialog-grid">
+    {#if title || $$slots.header}
+      <h1
+        class="spectrum-Dialog-heading spectrum-Dialog-heading--noHeader"
+        class:noDivider={!showDivider}
+        class:header-spacing={$$slots.header}
+      >
+        {#if title}
+          {title}
+        {:else if $$slots.header}
+          <slot name="header" />
+        {/if}
+      </h1>
+      {#if showDivider}
+        <Divider size="M" />
+      {/if}
+    {/if}
+
+    <!-- TODO: Remove content-grid class once Layout components are in bbui -->
+    <section class="spectrum-Dialog-content content-grid">
+      <slot />
+    </section>
+    {#if showCancelButton || showConfirmButton}
+      <div
+        class="spectrum-ButtonGroup spectrum-Dialog-buttonGroup spectrum-Dialog-buttonGroup--noFooter"
+      >
+        <slot name="footer" />
+
+        {#if showSecondaryButton && secondaryButtonText && secondaryAction}
+          <div class="secondary-action">
+            <Button
+              group
+              secondary
+              warning={secondaryButtonWarning}
+              on:click={secondary}>{secondaryButtonText}</Button
+            >
+          </div>
+        {/if}
+
+        {#if showCancelButton}
+          <Button group secondary newStyles on:click={close}>
+            {cancelText}
+          </Button>
+        {/if}
+        {#if showConfirmButton}
+          <span class="confirm-wrap">
+            <Button
+              group
+              cta
+              {...$$restProps}
+              disabled={confirmDisabled}
+              on:click={confirm}
+            >
+              {#if loading}
+                <ProgressCircle overBackground={true} size="S" />
+              {/if}
+              {#if !loading}
+                {confirmText}
+              {/if}
+            </Button>
+          </span>
+        {/if}
+      </div>
+    {/if}
+    {#if showCloseIcon}
+      <div class="close-icon">
+        <Icon hoverable name="Close" on:click={cancel} />
+      </div>
+    {/if}
+  </div>
+</div>
+
+<style>
+  .spectrum-Dialog--extraLarge {
+    width: 1000px;
+  }
+
+  .content-grid {
+    display: grid;
+    position: relative;
+    gap: var(--spacing-xl);
+  }
+
+  .spectrum-Dialog-content {
+    overflow: visible;
+  }
+  .spectrum-Dialog-heading {
+    font-family: var(--font-sans);
+  }
+  .spectrum-Dialog-heading.noDivider {
+    margin-bottom: 12px;
+  }
+
+  .spectrum-Dialog-buttonGroup {
+    gap: var(--spectrum-global-dimension-static-size-200);
+  }
+
+  .close-icon {
+    position: absolute;
+    top: 15px;
+    right: 15px;
+    font-size: var(--font-size-m);
+  }
+  .close-icon :global(svg) {
+    margin-right: 0;
+  }
+
+  .header-spacing {
+    display: flex;
+    justify-content: space-between;
+  }
+
+  .secondary-action {
+    margin-right: auto;
+  }
+
+  .spectrum-Dialog-buttonGroup {
+    padding-left: 0;
+  }
+
+  .confirm-wrap :global(.spectrum-Button-label) {
+    display: contents;
+  }
+</style>

package/src/Modal/QuizModal.svelte

@@ -0,0 +1,54 @@
+<script>
+  import ModalContent from "./ModalContent.svelte"
+  import Input from "../Form/Input.svelte"
+
+  let modal
+  let answer
+  let error
+
+  export function show() {
+    modal.show()
+  }
+  export function hide() {
+    modal.hide
+  }
+
+  function resetState() {
+    answer = undefined
+    error = undefined
+  }
+
+  async function answerQuiz() {
+    const correct = answer === "8"
+    error = !correct
+    return correct
+  }
+</script>
+
+<ModalContent
+  title="Quick Maths"
+  bind:this={modal}
+  confirmText="Submit"
+  onConfirm={answerQuiz}
+  on:show={resetState}
+>
+  {#if error}
+    <p class="error">Wrong answer! Try again.</p>
+  {/if}
+  <p>What is 4 + 4?</p>
+  <Input label="Answer" bind:value={answer} />
+</ModalContent>
+
+<style>
+  p {
+    margin: 0;
+    font-family: var(--font-sans);
+    font-size: var(--font-size-s);
+  }
+  p.error {
+    color: #e26d69;
+    background-color: #ffe6e6;
+    padding: 8px;
+    border-radius: 4px;
+  }
+</style>

package/src/Notification/Notification.svelte

@@ -0,0 +1,70 @@
+<script>
+  import { ActionButton } from "../"
+
+  import { createEventDispatcher } from "svelte"
+
+  export let type = "info"
+  export let icon = "Info"
+  export let message = ""
+  export let dismissable = false
+  export let actionMessage = null
+  export let action = null
+  export let wide = false
+
+  const dispatch = createEventDispatcher()
+</script>
+
+<div class="spectrum-Toast spectrum-Toast--{type}" class:wide>
+  {#if icon}
+    <svg
+      class="spectrum-Icon spectrum-Icon--sizeM spectrum-Toast-typeIcon"
+      focusable="false"
+      aria-hidden="true"
+    >
+      <use xlink:href="#spectrum-icon-18-{icon}" />
+    </svg>
+  {/if}
+  <div class="spectrum-Toast-body" class:actionBody={!!action}>
+    <div class="spectrum-Toast-content">{message || ""}</div>
+    {#if action}
+      <ActionButton quiet emphasized on:click={action}>
+        <div style="color: white; font-weight: 600;">{actionMessage}</div>
+      </ActionButton>
+    {/if}
+  </div>
+  {#if dismissable}
+    <div class="spectrum-Toast-buttons">
+      <button
+        class="spectrum-ClearButton spectrum-ClearButton--overBackground spectrum-ClearButton--sizeM"
+        on:click={() => dispatch("dismiss")}
+      >
+        <div class="spectrum-ClearButton-fill">
+          <svg
+            class="spectrum-ClearButton-icon spectrum-Icon spectrum-UIIcon-Cross100"
+            focusable="false"
+            aria-hidden="true"
+          >
+            <use xlink:href="#spectrum-css-icon-Cross100" />
+          </svg>
+        </div>
+      </button>
+    </div>
+  {/if}
+</div>
+
+<style>
+  .spectrum-Toast {
+    pointer-events: all;
+  }
+
+  .wide {
+    width: 100%;
+  }
+
+  .actionBody {
+    justify-content: space-between;
+    display: flex;
+    width: 100%;
+    align-items: center;
+  }
+</style>

package/src/Notification/NotificationDisplay.svelte

@@ -0,0 +1,43 @@
+<script>
+  import "@spectrum-css/toast/dist/index-vars.css"
+  import Portal from "svelte-portal"
+  import { notifications } from "../Stores/notifications"
+  import Notification from "./Notification.svelte"
+  import { fly } from "svelte/transition"
+</script>
+
+<Portal target=".modal-container">
+  <div class="notifications">
+    {#each $notifications as { type, icon, message, id, dismissable, action, wide } (id)}
+      <div transition:fly={{ y: 30 }}>
+        <Notification
+          {type}
+          {icon}
+          {message}
+          {dismissable}
+          {action}
+          {wide}
+          on:dismiss={() => notifications.dismiss(id)}
+        />
+      </div>
+    {/each}
+  </div>
+</Portal>
+
+<style>
+  .notifications {
+    position: fixed;
+    bottom: 40px;
+    left: 0;
+    right: 0;
+    margin: 0 auto;
+    padding: 0;
+    z-index: 9999;
+    display: flex;
+    flex-direction: column;
+    justify-content: flex-start;
+    align-items: center;
+    pointer-events: none;
+    gap: 10px;
+  }
+</style>

package/src/Pagination/Pagination.svelte

@@ -0,0 +1,57 @@
+<script>
+  import "@spectrum-css/pagination/dist/index-vars.css"
+  import "@spectrum-css/actionbutton/dist/index-vars.css"
+  import "@spectrum-css/typography/dist/index-vars.css"
+
+  export let page
+  export let goToPrevPage
+  export let goToNextPage
+  export let hasPrevPage = true
+  export let hasNextPage = true
+</script>
+
+<nav class="spectrum-Pagination spectrum-Pagination--explicit">
+  <div
+    href="#"
+    class="spectrum-ActionButton spectrum-ActionButton--sizeM spectrum-ActionButton--quiet spectrum-Pagination-prevButton"
+    on:click={hasPrevPage ? goToPrevPage : null}
+    class:is-disabled={!hasPrevPage}
+  >
+    <svg
+      class="spectrum-Icon spectrum-UIIcon-ChevronLeft100"
+      focusable="false"
+      aria-hidden="true"
+      aria-label="ChevronLeft"
+    >
+      <use xlink:href="#spectrum-css-icon-Chevron100" />
+    </svg>
+  </div>
+  <span class="spectrum-Body--secondary spectrum-Pagination-counter">
+    Page {page}
+  </span>
+  <div
+    href="#"
+    class="spectrum-ActionButton spectrum-ActionButton--sizeM spectrum-ActionButton--quiet spectrum-Pagination-nextButton"
+    on:click={hasNextPage ? goToNextPage : null}
+    class:is-disabled={!hasNextPage}
+  >
+    <svg
+      class="spectrum-Icon spectrum-UIIcon-ChevronRight100"
+      focusable="false"
+      aria-hidden="true"
+      aria-label="ChevronLeft"
+    >
+      <use xlink:href="#spectrum-css-icon-Chevron100" />
+    </svg>
+  </div>
+</nav>
+
+<style>
+  .spectrum-Pagination-counter {
+    margin-left: 0;
+    user-select: none;
+  }
+  .is-disabled:hover {
+    cursor: initial;
+  }
+</style>