@opengovsg/confetti 0.0.0-snapshot-20260130164049

package/LICENSE

@@ -0,0 +1,13 @@
+Except for any logos, trade marks, service marks, names, insignias, emblems, the Singapore state crest and Singapore national coat of arms, and/or any other graphic, image or sound which is used to identify any Singapore public sector agency or is associated with any Singapore public sector agency, or which belongs to a third party such as Shutterstock, Inc., and/or any asset or code identified by the Government Technology Agency (“GovTech”) as not licensed to you (such identification may come in the form of a filename labelled with “restricted” or similar phrasing, or via code comments), the contents of this repository are provided under the MIT License SUBJECT FURTHER TO THE FOLLOWING:
+
+(1) The MIT License and the terms herein (collectively, the “Terms”) shall be governed by the laws of Singapore. Any dispute arising out of or in connection with the Terms, including any question regarding its existence, validity or termination, shall be referred to and finally resolved by arbitration administered by the Singapore International Arbitration Centre (“SIAC”) in accordance with the Arbitration Rules of the Singapore International Arbitration Centre (“SIAC Rules”) for the time being in force, which rules are deemed to be incorporated by reference in this clause. The seat of arbitration shall be Singapore. The Tribunal shall consist of one (1) arbitrator. The language of the arbitration shall be English.
+
+MIT License
+
+Copyright 2025 Government Technology Agency.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,94 @@
+# @opengovsg/confetti
+
+Embeddable React survey widget for collecting user feedback.
+
+[![npm version](https://img.shields.io/npm/v/@opengovsg/confetti.svg)](https://www.npmjs.com/package/@opengovsg/confetti)
+
+## Installation
+
+```bash
+# npm
+npm install @opengovsg/confetti
+
+# yarn
+yarn add @opengovsg/confetti
+
+# pnpm
+pnpm add @opengovsg/confetti
+```
+
+### Peer Dependencies
+
+This package requires React 18.2.0+ or React 19:
+
+```bash
+npm install react@^18.2.0
+```
+
+## Quick Start
+
+1. Import the CSS file in your application entry point:
+
+```tsx
+import '@opengovsg/confetti/confetti.css'
+```
+
+2. Add the widget to your page:
+
+```tsx
+import { PopoverConfetti } from '@opengovsg/confetti'
+
+function App() {
+  return (
+    <div style={{ position: 'fixed', bottom: '1rem', right: '1rem' }}>
+      <PopoverConfetti
+        surveyId="your-survey-id"
+        publishableKey="your-publishable-key"
+        metadata={{}}
+      />
+    </div>
+  )
+}
+```
+
+> **Note:** You'll need the survey ID and publishable key from your Confetti dashboard. Make sure to whitelist your domain in your team settings.
+
+3. Add Confetti to your CSP headers:
+
+```
+connect-src https://confetti.hack2026.gov.sg;
+```
+
+## Template Components
+
+Choose the component that best fits your use case:
+
+| Component          | Use Case                          | Behavior                                                  |
+| ------------------ | --------------------------------- | --------------------------------------------------------- |
+| `EmbeddedConfetti` | Inline surveys, feedback sections | Shows questions in an inline manner with a submit button  |
+| `PopoverConfetti`  | Floating feedback widgets         | Dismissible popover, step-by-step questions, auto-submits |
+| `StepperConfetti`  | Guided surveys                    | One question at a time, auto-submits after last question  |
+
+## Visibility Hooks
+
+Control when your survey appears with these hooks:
+
+### useVisibleAfterDelay
+
+Show the survey after a delay:
+
+```tsx
+import { useVisibleAfterDelay } from '@opengovsg/confetti'
+
+const { isVisible } = useVisibleAfterDelay({ delay: 5000 }) // 5 seconds
+```
+
+### useVisibleAfterScroll
+
+Show the survey after scrolling a certain distance:
+
+```tsx
+import { useVisibleAfterScroll } from '@opengovsg/confetti'
+
+const { isVisible } = useVisibleAfterScroll({ threshold: 500 }) // 500px
+```

package/build/confetti.css

@@ -0,0 +1,486 @@
+:root {
+  --confetti-font-scale: 16px;
+  /* Define CSS Variables with defaults */
+  --confetti-box-padding: 20px 24px;
+  --confetti-max-width: 300px;
+  --confetti-z-index: 2147483647;
+  --confetti-border-color: #e4e4e7;
+  --confetti-border-bottom: 1.5px solid var(--confetti-border-color);
+  --confetti-border-radius: 12px;
+  --confetti-background-color: #ffffff;
+  --confetti-hover-background-color: #f5f5f5;
+  --confetti-box-shadow:
+    0 4px 6px -4px rgba(16, 24, 40, 0.1), 0 10px 15px -3px rgba(0, 0, 0, 0.1);
+  --confetti-focus-shadow: 0 0 0 2px rgba(9, 9, 11, 0.3);
+  --confetti-submit-button-color: #18181b;
+  --confetti-submit-button-text-color: #fafafa;
+  --confetti-rating-bg-color: white;
+  --confetti-rating-text-color: #09090b;
+  --confetti-rating-active-bg-color: #09090b;
+  --confetti-rating-active-text-color: white;
+
+  --confetti-indicator-active-bg-color: var(--confetti-rating-text-color);
+  --confetti-indicator-active-dot-color: white;
+
+  --confetti-text-primary-color: #09090b;
+  --confetti-text-subtle-color: #71717a;
+
+  /* Widget/Embedded Tab CSS Variables */
+  --confetti-widget-color: #e0a045; /* Default color */
+  --confetti-widget-text-color: white; /* Default text color (usually white for contrast) */
+  --confetti-scrollbar-thumb-color: var(--confetti-border-color);
+  --confetti-scrollbar-track-color: var(--confetti-background-color);
+  --confetti-outline-color: rgba(9, 9, 11, 0.8);
+  --confetti-input-background: white;
+  --confetti-input-text-color: #020617;
+  --confetti-disabled-button-opacity: 0.6;
+}
+
+.confetti-dialog {
+  width: var(--confetti-max-width);
+  max-width: 100%;
+  background: transparent;
+  position: relative;
+
+  .confetti-dialog-close {
+    position: absolute;
+    top: 8px;
+    right: 8px;
+    background: transparent;
+    border: none;
+    cursor: pointer;
+    padding: 8px;
+    border-radius: 8px;
+    transition: background 200ms;
+
+    & svg {
+      width: 16px;
+      height: 16px;
+      color: var(--confetti-text-subtle-color);
+    }
+
+    &:hover {
+      background: rgba(0, 0, 0, 0.05);
+    }
+
+    &:focus-visible {
+      outline: 2px solid var(--confetti-outline-color);
+      outline-offset: 2px;
+    }
+  }
+
+  /* Adjust title padding to accommodate close button */
+  .cf-header {
+    .cf-title {
+      padding-right: 20px;
+    }
+  }
+}
+
+.confetti {
+  font-family: var(--confetti-font-family);
+  overflow: hidden;
+  padding: 24px;
+  border-radius: var(--confetti-border-radius);
+  border: 1px solid var(--confetti-border-color);
+  display: flex;
+  flex-direction: column;
+  gap: 16px;
+  color: var(--confetti-text-primary-color);
+  font-size: var(--confetti-font-scale);
+  width: 100%;
+  background: var(--confetti-background-color);
+
+  box-shadow: var(--confetti-box-shadow);
+
+  .cf-submit-button {
+    align-self: end;
+    color: var(--confetti-submit-button-text-color);
+    background: var(--confetti-submit-button-color);
+    padding: 8px 16px;
+    border-radius: 8px;
+    cursor: pointer;
+    transition: transform 200ms;
+    font-size: 0.875em;
+    font-weight: 500;
+    line-height: 20px;
+
+    transition: background 200ms ease-out;
+
+    &:focus-visible {
+      outline: 2px solid var(--confetti-outline-color);
+      outline-offset: 2px;
+    }
+
+    &[data-disabled] {
+      opacity: var(--confetti-disabled-button-opacity);
+      cursor: not-allowed;
+      transform: none;
+    }
+
+    &:hover {
+      background: color-mix(
+        in srgb,
+        white 10%,
+        var(--confetti-submit-button-color)
+      );
+    }
+
+    &:active {
+      background: color-mix(
+        in srgb,
+        white 5%,
+        var(--confetti-submit-button-color)
+      );
+    }
+  }
+
+  .sr-only {
+    clip: rect(0, 0, 0, 0);
+    border: 0;
+    height: 1px;
+    margin: -1px;
+    overflow: hidden;
+    padding: 0;
+    position: absolute;
+    white-space: nowrap;
+    width: 1px;
+  }
+
+  .cf-response-choices {
+    display: flex;
+    flex-direction: column;
+    gap: 12px;
+  }
+
+  .cf-choice {
+    font-size: 1em;
+    cursor: pointer;
+    padding: 8px 10px;
+    border-radius: 6px;
+    border: 1px solid var(--confetti-border-color);
+
+    transition: background 200ms ease-out;
+
+    &:hover {
+      background: var(--confetti-hover-background-color);
+    }
+
+    .cf-choice-label {
+      gap: 8px;
+      display: inline-flex;
+      align-items: center;
+    }
+
+    .cf-choice-description {
+      font-size: 0.875em;
+      margin-left: 26px;
+      color: var(--confetti-text-subtle-color);
+    }
+  }
+
+  .cf-radio,
+  .cf-checkbox {
+    cursor: pointer;
+    display: flex;
+    flex-direction: column;
+    /* This is needed so the hidden input is positioned correctly */
+    position: relative;
+    align-items: start;
+    color: var(--confetti-text-primary-color);
+    forced-color-adjust: none;
+  }
+
+  .cf-checkbox {
+    --checkmark-color: var(--confetti-indicator-active-dot-color);
+
+    .cf-checkbox-indicator {
+      background: white;
+      border: 1px solid var(--confetti-border-color);
+      width: 18px;
+      height: 18px;
+      box-sizing: border-box;
+      border-radius: 4px;
+      transition: color 200ms ease-out;
+
+      display: flex;
+      align-items: center;
+      justify-content: center;
+      flex-shrink: 0;
+    }
+
+    svg {
+      width: calc(100% - 8px);
+      height: calc(100% - 8px);
+      fill: none;
+      stroke: var(--checkmark-color);
+      stroke-width: 3px;
+      stroke-dasharray: 22px;
+      stroke-dashoffset: 66;
+      stroke-linecap: round;
+      stroke-linejoin: round;
+      transition: all 200ms;
+    }
+
+    &[data-focus-visible='true'] {
+      .cf-checkbox-indicator {
+        outline: 2px solid var(--confetti-outline-color);
+        outline-offset: 2px;
+      }
+    }
+    &[data-selected],
+    &[data-indeterminate] {
+      .cf-checkbox-indicator {
+        background: var(--confetti-indicator-active-bg-color);
+        border: none;
+      }
+      svg {
+        stroke-dashoffset: 44;
+      }
+    }
+
+    &[data-indeterminate] {
+      svg {
+        stroke: none;
+        fill: var(--checkmark-color);
+      }
+    }
+  }
+
+  .cf-radio {
+    -webkit-tap-highlight-color: transparent;
+    --dot-color: var(--confetti-indicator-active-dot-color);
+
+    .cf-radio-indicator {
+      position: relative;
+      width: 18px;
+      height: 18px;
+      box-sizing: border-box;
+      border-radius: 50%;
+      transition: color 200ms ease-out;
+      border: 1px solid var(--confetti-border-color);
+      background: white;
+
+      &::after {
+        content: '';
+        position: absolute;
+        inset: 1px;
+        border-radius: inherit;
+        background: transparent;
+        transition: scale 200ms;
+        scale: 0;
+      }
+    }
+
+    &[data-selected] {
+      .cf-radio-indicator {
+        background: var(--confetti-indicator-active-bg-color);
+        border-color: var(--confetti-indicator-active-bg-color);
+
+        &::after {
+          background: var(--dot-color);
+          scale: 0.4;
+        }
+      }
+    }
+
+    &[data-disabled] {
+      color: var(--text-color-disabled);
+      --dot-color: var(--text-color-disabled);
+    }
+
+    &[data-focus-visible='true'] {
+      .cf-radio-indicator {
+        outline: 2px solid var(--confetti-outline-color);
+        outline-offset: 2px;
+      }
+    }
+  }
+
+  .cf-input,
+  .cf-textarea {
+    background: var(--confetti-input-background);
+    border: 1px solid var(--confetti-border-color);
+    border-radius: 8px;
+    color: var(--confetti-input-text-color);
+    padding: 10px;
+    transition:
+      border-color 0.2s ease-out,
+      box-shadow 0.2s ease-out,
+      transform 0.15s ease-out;
+
+    &:focus {
+      border-color: var(--confetti-outline-color);
+      box-shadow: var(--confetti-focus-shadow);
+      outline: none;
+    }
+  }
+
+  .cf-question {
+    display: flex;
+    flex-direction: column;
+    gap: 16px;
+
+    .cf-error {
+      display: none;
+    }
+
+    .cf-header {
+      display: flex;
+      flex-direction: column;
+      gap: 2px;
+
+      .cf-title {
+        line-height: 24px;
+        font-weight: 500;
+      }
+
+      .cf-label-optional {
+        font-weight: 400;
+        color: var(--confetti-text-subtle-color);
+      }
+
+      .cf-description {
+        font-size: 0.875em;
+        line-height: 20px;
+        font-weight: 400;
+        color: var(--confetti-text-subtle-color);
+      }
+    }
+
+    .cf-others-choice {
+      display: flex;
+      flex-direction: column;
+      gap: 8px;
+    }
+  }
+
+  .cf-rating-section {
+    display: flex;
+    flex-direction: column;
+    gap: 4px;
+  }
+
+  .cf-rating-tiff {
+    overflow: hidden;
+    border-radius: 100%;
+  }
+
+  .cf-rating-tiff,
+  .cf-rating-emoji {
+    opacity: 0.5;
+  }
+
+  .cf-rating-display-tiff,
+  .cf-rating-display-star,
+  .cf-rating-display-emoji {
+    display: grid;
+    grid-template-columns: repeat(auto-fit, 40px);
+    justify-content: space-between;
+    gap: 8px;
+
+    .cf-rating-tiff,
+    .cf-rating-emoji,
+    .cf-rating-star {
+      font-size: 1em;
+      background-color: transparent;
+      border: none;
+      padding: 0;
+      transition: transform 0.15s ease-out;
+      color: var(--confetti-rating-active-bg-color);
+
+      &[data-focus-visible='true'] {
+        outline: 2px solid var(--confetti-outline-color);
+        outline-offset: 2px;
+      }
+
+      &:hover {
+        cursor: pointer;
+        transform: scale(1.15);
+        opacity: 1 !important;
+      }
+
+      &[data-filled='true'] {
+        opacity: 1;
+      }
+
+      &[data-selected='true'] {
+        opacity: 1;
+      }
+
+      & svg {
+        /* Smooth color transitions */
+        transition: fill 0.15s ease-out;
+      }
+    }
+  }
+
+  .cf-rating-text {
+    display: flex;
+    justify-content: space-between;
+    font-size: 0.75em;
+    color: var(--confetti-text-subtle-color);
+    font-weight: 500;
+    line-height: 1;
+
+    .cf-rating-text-lower {
+      flex: 1;
+      text-align: start;
+    }
+
+    .cf-rating-text-upper {
+      flex: 1;
+      text-align: end;
+    }
+  }
+
+  /* Special classes to make previous radio filled with color when one is selected */
+  .cf-rating-display-star {
+    .cf-rating-star[data-selected='true'] ~ .cf-rating-star {
+      opacity: 0.5;
+    }
+  }
+
+  .cf-rating-display-number {
+    display: grid;
+    grid-auto-columns: 1fr;
+    grid-auto-flow: column;
+    border: 1px solid var(--confetti-border-color);
+    border-radius: 8px;
+    overflow: hidden;
+
+    .cf-rating-number {
+      border-right: 1px solid var(--confetti-border-color);
+      text-align: center;
+      cursor: pointer;
+      color: var(--confetti-rating-text-color);
+      border-left: none;
+      border-top: none;
+      border-bottom: none;
+      font-weight: 700;
+      padding: 8px 0;
+      margin-top: -1px;
+      margin-bottom: -1px;
+
+      &:first-of-type {
+        border-top-left-radius: 8px;
+        border-bottom-left-radius: 8px;
+      }
+
+      &:last-of-type {
+        border-top-right-radius: 8px;
+        border-bottom-right-radius: 8px;
+        border-right: 0;
+      }
+
+      &[data-focus-visible='true'] {
+        box-shadow: inset 0 0 0 1px var(--confetti-outline-color);
+      }
+
+      &[data-selected='true'] {
+        background: var(--confetti-rating-active-bg-color);
+        color: var(--confetti-rating-active-text-color);
+      }
+    }
+  }
+}