@budibase/bbui 3.5.2 → 3.6.0

package/src/Notification/Notification.svelte

@@ -1,17 +1,17 @@
-<script>
+<script lang="ts">
   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
+  export let type: string = "info"
+  export let icon: string = "Info"
+  export let message: string = ""
+  export let dismissable: boolean = false
+  export let actionMessage: string | null = null
+  export let action: ((_dismiss: () => void) => void) | null = null
+  export let wide: boolean = false
 
-  const dispatch = createEventDispatcher()
+  const dispatch = createEventDispatcher<{ dismiss: void }>()
 </script>
 
 <div class="spectrum-Toast spectrum-Toast--{type}" class:wide>

package/src/Notification/NotificationDisplay.svelte

@@ -1,4 +1,4 @@
-<script>
+<script lang="ts">
   import "@spectrum-css/toast/dist/index-vars.css"
   import Portal from "svelte-portal"
   import { notifications } from "../Stores/notifications"

package/src/Pagination/Pagination.svelte

@@ -1,20 +1,19 @@
-<script>
+<script lang="ts">
   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
+  export let page: number
+  export let goToPrevPage: () => void
+  export let goToNextPage: () => void
+  export let hasPrevPage: boolean = true
+  export let hasNextPage: boolean = true
 </script>
 
 <!-- svelte-ignore a11y-no-static-element-interactions -->
 <!-- svelte-ignore a11y-click-events-have-key-events -->
 <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}
@@ -32,7 +31,6 @@
     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}

package/src/ProgressBar/ProgressBar.svelte

@@ -1,25 +1,24 @@
-<script>
+<script lang="ts">
   import "@spectrum-css/progressbar/dist/index-vars.css"
 
-  export let value = false
-  export let duration = 1000
-  export let width = false
-  export let sideLabel = false
-  export let hidePercentage = true
-  export let color // red, green, default = blue
-  export let size = "M"
+  export let value: number | boolean = false
+  export let duration: number = 1000
+  export let width: string | boolean = false
+  export let sideLabel: boolean = false
+  export let hidePercentage: boolean = true
+  export let color: "red" | "green" | undefined = undefined // red, green, default = blue
+  export let size: string = "M"
 </script>
 
 <div
   class:spectrum-ProgressBar--indeterminate={!value && value !== 0}
   class:spectrum-ProgressBar--sideLabel={sideLabel}
   class="spectrum-ProgressBar spectrum-ProgressBar--size{size}"
-  {value}
   role="progressbar"
-  aria-valuenow={value}
+  aria-valuenow={typeof value === "number" ? value : undefined}
   aria-valuemin="0"
   aria-valuemax="100"
-  style={width ? `width: ${width};` : ""}
+  style={width ? `width: ${typeof width === "string" ? width : ""};` : ""}
 >
   {#if $$slots}
     <div
@@ -32,7 +31,7 @@
     <div
       class="spectrum-FieldLabel spectrum-ProgressBar-percentage spectrum-FieldLabel--size{size}"
     >
-      {Math.round(value)}%
+      {Math.round(Number(value))}%
     </div>
   {/if}
   <div class="spectrum-ProgressBar-track">
@@ -40,10 +39,12 @@
       class="spectrum-ProgressBar-fill"
       class:color-green={color === "green"}
       class:color-red={color === "red"}
-      style="width: {value}%; --duration: {duration}ms;"
+      style="width: {typeof value === 'number'
+        ? value
+        : 0}%; --duration: {duration}ms;"
     />
   </div>
-  <div class="spectrum-ProgressBar-label" hidden="" />
+  <div class="spectrum-ProgressBar-label" hidden={false} />
 </div>
 
 <style>

package/src/ProgressCircle/ProgressCircle.svelte

@@ -1,8 +1,8 @@
-<script>
+<script lang="ts">
   import "@spectrum-css/progresscircle/dist/index-vars.css"
 
-  export let size = "M"
-  function convertSize(size) {
+  export let size: "S" | "M" | "L" = "M"
+  function convertSize(size: "S" | "M" | "L"): string | undefined {
     switch (size) {
       case "S":
         return "small"
@@ -13,18 +13,18 @@
     }
   }
 
-  export let value = null
-  export let minValue = 0
-  export let maxValue = 100
+  export let value: number | null = null
+  export let minValue: number = 0
+  export let maxValue: number = 100
 
-  let subMask1Style
-  let subMask2Style
+  let subMask1Style: string | undefined
+  let subMask2Style: string | undefined
   $: calculateSubMasks(value)
 
-  function calculateSubMasks(value) {
+  function calculateSubMasks(value: number | null): void {
     if (value) {
       let percentage = ((value - minValue) / (maxValue - minValue)) * 100
-      let angle
+      let angle: number
       if (percentage > 0 && percentage <= 50) {
         angle = -180 + (percentage / 50) * 180
         subMask1Style = `transform: rotate(${angle}deg);`
@@ -37,7 +37,7 @@
     }
   }
 
-  export let overBackground = false
+  export let overBackground: boolean = false
 </script>
 
 <!-- svelte-ignore a11y-no-static-element-interactions -->

package/src/Tooltip/TooltipWrapper.svelte

@@ -3,7 +3,7 @@
   import AbsTooltip from "./AbsTooltip.svelte"
 
   export let tooltip: string = ""
-  export let size: "S" | "M" = "M"
+  export let size: "S" | "M" | "L" = "M"
   export let disabled: boolean = true
 </script>
 

package/src/bbui.css

@@ -11,6 +11,16 @@
   --bb-forest-green: #053835;
   --bb-beige: #f6efea;
 
+  /* Custom spectrum additions */
+  --spectrum-global-color-static-red-1200: #740000;
+  --spectrum-global-color-static-orange-1200: #612300;
+  --spectrum-global-color-static-yellow-1200: #483300;
+  --spectrum-global-color-static-green-1200: #053f27;
+  --spectrum-global-color-static-seafoam-1200: #123c3a;
+  --spectrum-global-color-static-blue-1200: #003571;
+  --spectrum-global-color-static-indigo-1200: #262986;
+  --spectrum-global-color-static-magenta-1200: #700037;
+
   --grey-1: #fafafa;
   --grey-2: #f5f5f5;
   --grey-3: #eeeeee;

package/src/context.d.ts

@@ -0,0 +1,8 @@
+import { ActionMenu } from "./types"
+
+declare module "svelte" {
+  export function getContext(key: "actionMenu"): ActionMenu | undefined
+}
+
+export const Modal = "bbui-modal"
+export const PopoverRoot = "bbui-popover-root"

package/src/index.ts

@@ -17,7 +17,6 @@ export { default as Toggle } from "./Form/Toggle.svelte"
 export { default as RadioGroup } from "./Form/RadioGroup.svelte"
 export { default as Checkbox } from "./Form/Checkbox.svelte"
 export { default as InputDropdown } from "./Form/InputDropdown.svelte"
-export { default as PickerDropdown } from "./Form/PickerDropdown.svelte"
 export { default as EnvDropdown } from "./Form/EnvDropdown.svelte"
 export { default as Multiselect } from "./Form/Multiselect.svelte"
 export { default as Search } from "./Form/Search.svelte"
@@ -87,8 +86,6 @@ export { default as MarkdownEditor } from "./Markdown/MarkdownEditor.svelte"
 export { default as MarkdownViewer } from "./Markdown/MarkdownViewer.svelte"
 export { default as List } from "./List/List.svelte"
 export { default as ListItem } from "./List/ListItem.svelte"
-export { default as IconSideNav } from "./IconSideNav/IconSideNav.svelte"
-export { default as IconSideNavItem } from "./IconSideNav/IconSideNavItem.svelte"
 export { default as Accordion } from "./Accordion/Accordion.svelte"
 export { default as AbsTooltip } from "./Tooltip/AbsTooltip.svelte"
 

package/src/types/actionMenu.ts

@@ -0,0 +1,3 @@
+export interface ActionMenu {
+  hide: () => void
+}

package/src/Form/PickerDropdown.svelte

@@ -1,132 +0,0 @@
-<script>
-  import Field from "./Field.svelte"
-  import PickerDropdown from "./Core/PickerDropdown.svelte"
-  import { createEventDispatcher } from "svelte"
-
-  export let primaryValue = null
-  export let secondaryValue = null
-  export let inputType = "text"
-  export let label = null
-  export let labelPosition = "above"
-  export let secondaryPlaceholder = null
-  export let autocomplete
-  export let placeholder = null
-  export let disabled = false
-  export let readonly = false
-  export let error = null
-  export let getSecondaryOptionLabel = option =>
-    extractProperty(option, "label")
-  export let getSecondaryOptionValue = option =>
-    extractProperty(option, "value")
-  export let getSecondaryOptionColour = () => {}
-  export let getSecondaryOptionIcon = () => {}
-  export let quiet = false
-  export let autofocus
-  export let primaryOptions = []
-  export let secondaryOptions = []
-  export let searchTerm
-  export let showClearIcon = true
-  export let helpText = null
-
-  let primaryLabel
-  let secondaryLabel
-  const dispatch = createEventDispatcher()
-
-  $: secondaryFieldText = getSecondaryFieldText(
-    secondaryValue,
-    secondaryOptions,
-    secondaryPlaceholder
-  )
-  $: secondaryFieldIcon = getSecondaryFieldAttribute(
-    getSecondaryOptionIcon,
-    secondaryValue,
-    secondaryOptions
-  )
-  $: secondaryFieldColour = getSecondaryFieldAttribute(
-    getSecondaryOptionColour,
-    secondaryValue,
-    secondaryOptions
-  )
-
-  const getSecondaryFieldAttribute = (getAttribute, value, options) => {
-    // Wait for options to load if there is a value but no options
-
-    if (!options?.length) {
-      return ""
-    }
-
-    const index = options.findIndex(
-      (option, idx) => getSecondaryOptionValue(option, idx) === value
-    )
-
-    return index !== -1 ? getAttribute(options[index], index) : null
-  }
-
-  const getSecondaryFieldText = (value, options, placeholder) => {
-    // Always use placeholder if no value
-    if (value == null || value === "") {
-      return placeholder || "Choose an option"
-    }
-
-    return getSecondaryFieldAttribute(getSecondaryOptionLabel, value, options)
-  }
-
-  const onPickPrimary = e => {
-    primaryLabel = e?.detail?.label || null
-    primaryValue = e?.detail?.value || null
-    dispatch("pickprimary", e?.detail?.value || {})
-  }
-
-  const onPickSecondary = e => {
-    secondaryValue = e.detail
-    dispatch("picksecondary", e.detail)
-  }
-
-  const extractProperty = (value, property) => {
-    if (value && typeof value === "object") {
-      return value[property]
-    }
-    return value
-  }
-
-  const updateSearchTerm = e => {
-    searchTerm = e.detail
-  }
-</script>
-
-<Field {helpText} {label} {labelPosition} {error}>
-  <PickerDropdown
-    {searchTerm}
-    {autocomplete}
-    {error}
-    {disabled}
-    {readonly}
-    {placeholder}
-    {inputType}
-    {quiet}
-    {autofocus}
-    {primaryOptions}
-    {secondaryOptions}
-    {getSecondaryOptionLabel}
-    {getSecondaryOptionValue}
-    {getSecondaryOptionIcon}
-    {getSecondaryOptionColour}
-    {secondaryFieldText}
-    {secondaryFieldIcon}
-    {secondaryFieldColour}
-    {primaryValue}
-    {secondaryValue}
-    {primaryLabel}
-    {secondaryLabel}
-    {showClearIcon}
-    on:pickprimary={onPickPrimary}
-    on:picksecondary={onPickSecondary}
-    on:search={updateSearchTerm}
-    on:click
-    on:input
-    on:blur
-    on:focus
-    on:keyup
-    on:closed
-  />
-</Field>

package/src/IconSideNav/IconSideNav.svelte

@@ -1,14 +0,0 @@
-<div class="icon-side-nav">
-  <slot />
-</div>
-
-<style>
-  .icon-side-nav {
-    display: flex;
-    flex-direction: column;
-    justify-content: flex-start;
-    align-items: center;
-    padding: var(--spacing-s);
-    gap: var(--spacing-xs);
-  }
-</style>

package/src/IconSideNav/IconSideNavItem.svelte

@@ -1,58 +0,0 @@
-<script>
-  import Icon from "../Icon/Icon.svelte"
-  import Tooltip from "../Tooltip/Tooltip.svelte"
-  import { fade } from "svelte/transition"
-
-  export let icon
-  export let active = false
-  export let tooltip
-
-  let showTooltip = false
-</script>
-
-<!-- svelte-ignore a11y-no-static-element-interactions -->
-<!-- svelte-ignore a11y-click-events-have-key-events -->
-<div
-  class="icon-side-nav-item"
-  class:active
-  on:mouseover={() => (showTooltip = true)}
-  on:focus={() => (showTooltip = true)}
-  on:mouseleave={() => (showTooltip = false)}
-  on:click
->
-  <Icon name={icon} hoverable />
-  {#if tooltip && showTooltip}
-    <div class="tooltip" in:fade={{ duration: 130, delay: 250 }}>
-      <Tooltip textWrapping direction="right" text={tooltip} />
-    </div>
-  {/if}
-</div>
-
-<style>
-  .icon-side-nav-item {
-    width: 36px;
-    height: 36px;
-    display: grid;
-    place-items: center;
-    border-radius: 4px;
-    position: relative;
-    cursor: pointer;
-    transition: background 130ms ease-out;
-  }
-  .icon-side-nav-item:hover :global(svg),
-  .active :global(svg) {
-    color: var(--spectrum-global-color-gray-900);
-  }
-  .active {
-    background: var(--spectrum-global-color-gray-300);
-  }
-  .tooltip {
-    position: absolute;
-    pointer-events: none;
-    left: calc(100% - 4px);
-    top: 50%;
-    white-space: nowrap;
-    transform: translateY(-50%);
-    z-index: 1;
-  }
-</style>

package/src/Menu/Menu.svench

@@ -1,19 +0,0 @@
-<script>
-    import Menu from './Menu.svelte'
-    import Separator from './Separator.svelte'
-    import Section from './Section.svelte'
-    import Item from './Item.svelte'
-</script>
-
-<Menu>
-    <Section heading="Section heading">
-        <Item>Some Item 1</Item>
-        <Item>Some Item 2</Item>
-        <Item>Some Item 3</Item>
-    </Section>
-    <Separator />
-    <Section heading="Section heading">
-        <Item icon="SaveFloppy">Save</Item>
-        <Item disabled icon="DataDownload">Download</Item>
-    </Section>
-</Menu>

package/src/Modal/Modal.svench

@@ -1,116 +0,0 @@
-<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-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/QuizModal.svelte

@@ -1,53 +0,0 @@
-<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-size: var(--font-size-s);
-  }
-  p.error {
-    color: #e26d69;
-    background-color: #ffe6e6;
-    padding: 8px;
-    border-radius: 4px;
-  }
-</style>