@ogds/elements 1.0.0-alpha.6

package/src/components/usa-banner/usa-banner.css

@@ -0,0 +1,511 @@
+:host {
+  /** Component tokens */
+  --ogds-banner-background-color: var(--ogds-color-base-lightest, #f0f0f0);
+  --ogds-banner-button-close-background-color: var(
+    --ogds-color-base-lighter,
+    #dfe1e2
+  );
+  --ogds-banner-focus-outline-color: var(--ogds-color-blue-vivid-40, #2491ff);
+  --ogds-banner-font-family:
+    system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica,
+    Arial, sans-serif;
+  --ogds-banner-font-size-xs: 0.75rem;
+  --ogds-banner-font-size-sm: 0.875rem;
+  --ogds-banner-font-size-base: 0.94rem;
+  --ogds-banner-icon-gov-color: var(--ogds-color-blue-50, #2378c3);
+  --ogds-banner-icon-https-color: var(--ogds-color-green-vivid-40, #719f2a);
+  --ogds-banner-line-height-sm: 1.2;
+  --ogds-banner-line-height-base: 1.6;
+  --ogds-banner-link-color: var(--ogds-color-blue-vivid-60, #005ea2);
+  --ogds-banner-link-hover-color: var(--ogds-color-blue-warm-vivid-70, #1a4480);
+  --ogds-banner-max-width: var(--ogds-breakpoint-desktop);
+  --ogds-banner-text-color: var(--ogds-color-base-darkest, #1b1b1b);
+
+  /**
+   * Icons
+   * Note: icons that are part of the USWDS icon library and imported from
+   * svgs have their import and associated variables defined in the component's
+   * index.ts file where the `unsafeCSS` function is used to generate the appropriate
+   * data URI. The variable definition below is an exception since it is an ad-hoc
+   * icon that is not part of the USWDS icon library.
+   */
+  --ogds-icon-lock: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='52' height='64' viewBox='0 0 52 64' class='usa-banner__lock-image' role='img' aria-labelledby='banner-lock-description-default' focusable='false'%3E%3Ctitle id='banner-lock-title-default'%3ELock%3C/title%3E%3Cdesc id='banner-lock-description-default'%3ELocked padlock icon%3C/desc%3E%3Cpath fill='%23000000' fill-rule='evenodd' d='M26 0c10.493 0 19 8.507 19 19v9h3a4 4 0 0 1 4 4v28a4 4 0 0 1-4 4H4a4 4 0 0 1-4-4V32a4 4 0 0 1 4-4h3v-9C7 8.507 15.507 0 26 0zm0 8c-5.979 0-10.843 4.77-10.996 10.712L15 19v9h22v-9c0-6.075-4.925-11-11-11z'%3E%3C/path%3E%3C/svg%3E");
+}
+
+* {
+  box-sizing: border-box;
+}
+
+section {
+  background-color: var(--ogds-banner-background-color);
+  box-sizing: border-box;
+  font-family: var(--ogds-banner-font-family);
+  font-size: var(--ogds-banner-font-size-xs);
+  text-align: start;
+}
+
+section *,
+section *::before,
+section *::after {
+  box-sizing: border-box;
+}
+
+@media (width >= 40em) {
+  section {
+    font-size: var(--ogds-banner-font-size-xs);
+    padding-block-end: 0;
+  }
+}
+
+section .usa-accordion {
+  font-family: inherit;
+}
+
+section .grid-row {
+  display: grid;
+
+  /**
+   * This creates a responsive grid where:
+   * - Columns auto-fit based on available space
+   * - Each column has a minimum width that's the smaller of 100% or half the tablet breakpoint (20rem)
+   * - Columns can grow to fill remaining space (1fr)
+   */
+  grid-template-columns: repeat(
+    auto-fit,
+    minmax(min(100%, calc(var(--ogds-breakpoint-tablet) / 2)), 1fr)
+  );
+}
+
+@media (width >= 40em) {
+  section .grid-row {
+    gap: var(--ogds-spacing-2);
+  }
+}
+
+@media (width >= 64em) {
+  section .grid-row {
+    gap: calc(var(--ogds-spacing-05) / 2);
+  }
+}
+
+.grid-col-auto {
+  flex: 0 1 auto;
+}
+
+.grid-col-fill {
+  flex: 1 1 0;
+  max-width: 100%;
+  min-width: 1px;
+  width: auto;
+}
+
+@media (width >= 40em) {
+  .tablet\:grid-col-auto {
+    flex: 0 1 auto;
+    max-width: 100%;
+    width: auto;
+  }
+}
+
+section .tablet\:grid-col-6 {
+  flex: 0 0 auto;
+  gap: var(--ogds-spacing-1);
+  width: 100%;
+}
+
+header,
+.content {
+  color: var(--ogds-banner-text-color);
+}
+
+.content {
+  font-size: var(--ogds-banner-font-size-base);
+  line-height: var(--ogds-banner-line-height-base);
+  margin-inline: auto;
+  max-width: var(--ogds-banner-max-width);
+  overflow: hidden;
+  padding-block-end: var(--ogds-spacing-2);
+  padding-block-start: var(--ogds-spacing-05);
+  padding-inline: var(--ogds-spacing-1);
+  width: 100%;
+}
+
+@media (width >= 40em) {
+  .content {
+    padding-block: var(--ogds-spacing-3);
+  }
+}
+
+@media (width >= 64em) {
+  .content {
+    padding-inline: var(--ogds-spacing-4);
+  }
+}
+
+.content p:first-child {
+  margin: 0;
+}
+
+.inner {
+  align-items: flex-start;
+  display: flex;
+  flex-wrap: nowrap;
+  margin-inline: auto;
+  max-width: var(--ogds-banner-max-width);
+  padding-inline-end: var(--ogds-spacing-05);
+  padding-inline-start: var(--ogds-spacing-2);
+}
+
+@media (width >= 40em) {
+  .inner {
+    align-items: center;
+  }
+}
+
+@media (width >= 64em) {
+  .inner {
+    padding-inline: var(--ogds-spacing-4);
+  }
+}
+
+header {
+  font-size: var(--ogds-banner-font-size-xs);
+  font-weight: 400;
+  min-height: var(--ogds-size-touch-target);
+  padding-block: var(--ogds-spacing-1);
+  position: relative;
+}
+
+@media (width >= 40em) {
+  header {
+    min-height: 0;
+    padding-block: var(--ogds-spacing-05);
+  }
+}
+
+.header-text {
+  font-size: var(--ogds-banner-font-size-xs);
+  line-height: var(--ogds-banner-line-height-sm);
+  margin-block: 0;
+}
+
+.header-flag {
+  float: left;
+  margin-inline-end: var(--ogds-spacing-1);
+  padding-block-start: 0;
+  width: var(--ogds-spacing-2);
+}
+
+.header-action {
+  background: none;
+  border: none;
+  color: var(--ogds-banner-link-color);
+  cursor: pointer;
+  font: inherit;
+  line-height: var(--ogds-banner-line-height-sm);
+  margin-block-end: 0;
+  margin-block-start: 2px;
+  padding: 0;
+  text-decoration: underline;
+}
+
+.header-action:hover {
+  color: var(--ogds-banner-link-hover-color);
+}
+
+.header-action::after {
+  background-color: currentColor;
+  content: "";
+  display: inline-block;
+  height: 1rem;
+  mask-image: var(--ogds-icon-expand-more);
+  mask-position: center;
+  mask-repeat: no-repeat;
+  mask-size: 1rem 1rem;
+  vertical-align: middle;
+  width: 1rem;
+}
+
+.expanded .header-action {
+  display: none;
+}
+
+@media (width >= 40em) {
+  .header-action {
+    display: none;
+  }
+}
+
+@media (forced-colors: active) {
+  .header-action {
+    color: LinkText;
+  }
+
+  .header-action::after {
+    background-color: ButtonText;
+  }
+}
+
+header.expanded {
+  padding-inline-end: calc(
+    var(--ogds-size-touch-target) + var(--ogds-spacing-1)
+  );
+}
+
+@media (width >= 40em) {
+  header.expanded {
+    display: block;
+    font-size: var(--ogds-banner-font-size-sm);
+    font-weight: 400;
+    min-height: 0;
+    padding-inline-end: 0;
+  }
+}
+
+header.expanded .inner {
+  margin-inline-start: 0;
+}
+
+@media (width >= 40em) {
+  header.expanded .inner {
+    margin-inline-start: auto;
+  }
+}
+
+header.expanded .header-action {
+  display: none;
+}
+
+button {
+  background: none;
+  border: none;
+  bottom: 0;
+  color: var(--ogds-banner-link-color);
+  cursor: pointer;
+  display: block;
+  font: inherit;
+  font-size: var(--ogds-banner-font-size-xs);
+  height: auto;
+  left: 0;
+  line-height: var(--ogds-banner-line-height-sm);
+  outline: inherit;
+  padding: 0;
+  padding-block-start: 0;
+  padding-inline-start: 0;
+  position: absolute;
+  text-decoration: none;
+  top: 0;
+  width: auto;
+}
+
+button:hover {
+  color: var(--ogds-banner-link-hover-color);
+}
+
+@media (width <= 39.99em) {
+  button {
+    width: 100%;
+  }
+
+  button:enabled:focus {
+    outline-offset: -0.25rem;
+  }
+}
+
+button:not([disabled]):focus {
+  outline: var(--ogds-spacing-05) solid var(--ogds-banner-focus-outline-color);
+}
+
+@media (width >= 40em) {
+  button {
+    bottom: auto;
+    display: inline;
+    left: auto;
+    margin-inline-start: var(--ogds-spacing-1);
+    position: relative;
+    top: auto;
+  }
+
+  button::after {
+    background-color: currentColor;
+    content: "";
+    display: inline-block;
+    height: 1rem;
+    margin-block: 0;
+    mask-image: var(--ogds-icon-expand-more);
+    mask-position: center;
+    mask-repeat: no-repeat;
+    mask-size: contain;
+    position: absolute;
+    right: -18px;
+    top: 0;
+    width: 1rem;
+  }
+
+  button:hover {
+    text-decoration: none;
+  }
+}
+
+@media (forced-colors: active) {
+  button::after,
+  button:hover::after {
+    background-color: ButtonText;
+  }
+}
+
+button[aria-expanded="false"],
+button[aria-expanded="false"]:hover,
+button[aria-expanded="true"],
+button[aria-expanded="true"]:hover {
+  background-image: none;
+}
+
+@media (forced-colors: active) {
+  button[aria-expanded="false"]::before,
+  button[aria-expanded="false"]:hover::before,
+  button[aria-expanded="true"]::before,
+  button[aria-expanded="true"]:hover::before {
+    content: none;
+  }
+}
+
+@media (width <= 39.99em) {
+  button[aria-expanded="true"]::before {
+    background-color: var(--ogds-banner-button-close-background-color);
+    bottom: 0;
+    content: "";
+    display: block;
+    height: var(--ogds-size-touch-target);
+    position: absolute;
+    right: 0;
+    top: 0;
+    width: var(--ogds-size-touch-target);
+  }
+
+  button[aria-expanded="true"]::after {
+    background-color: var(--ogds-banner-link-color);
+    bottom: 0;
+    content: "";
+    display: block;
+    height: var(--ogds-size-touch-target);
+    mask-image: var(--ogds-icon-close);
+    mask-position: center;
+    mask-repeat: no-repeat;
+    mask-size: 1.5rem 1.5rem;
+    position: absolute;
+    right: 0;
+    top: 0;
+    width: var(--ogds-size-touch-target);
+  }
+}
+
+@media (width >= 40em) {
+  button[aria-expanded="true"] {
+    height: auto;
+    padding: 0;
+    position: relative;
+  }
+
+  button[aria-expanded="true"]::after,
+  button[aria-expanded="true"]:hover::after {
+    mask-image: var(--ogds-icon-expand-less);
+    position: absolute;
+  }
+}
+
+@media (forced-colors: active) {
+  button[aria-expanded="true"]::after,
+  button[aria-expanded="true"]:hover::after {
+    background-color: ButtonText;
+  }
+}
+
+.button-text {
+  left: -999em;
+  position: absolute;
+  right: auto;
+  text-decoration: underline;
+}
+
+@media (width >= 40em) {
+  .button-text {
+    display: inline;
+    left: auto;
+    position: static;
+    right: auto;
+  }
+}
+
+@media (forced-colors: active) {
+  .button-text {
+    color: LinkText;
+  }
+}
+
+.guidance {
+  align-items: flex-start;
+  display: flex;
+  max-width: 62ex;
+  padding-block-start: var(--ogds-spacing-2);
+}
+
+@media (width <= 39.99em) {
+  .guidance {
+    padding-inline-end: 0.75rem;
+  }
+}
+
+@media (width >= 40em) {
+  .guidance {
+    padding-block-start: 0;
+    padding-inline-end: var(--ogds-spacing-1);
+  }
+}
+
+.icon {
+  width: var(--ogds-spacing-5);
+}
+
+.icon-lock,
+::slotted(.usa-banner__icon-lock) {
+  background-color: currentColor;
+  background-position: center;
+  background-repeat: no-repeat;
+  background-size: cover;
+  display: inline-block;
+  height: 1.5ex;
+  mask-image: var(--ogds-icon-lock);
+  mask-position: center;
+  mask-repeat: no-repeat;
+  mask-size: cover;
+  width: 1.21875ex;
+}
+
+.icon-gov,
+.icon-https {
+  padding-inline-start: calc(var(--ogds-spacing-5) + var(--ogds-spacing-1));
+  position: relative;
+
+  &::before {
+    content: "";
+    display: inline-block;
+    height: var(--ogds-spacing-5);
+    left: 0;
+    mask-repeat: no-repeat;
+    mask-size: contain;
+    position: absolute;
+    top: 0;
+    width: var(--ogds-spacing-5);
+  }
+}
+
+.icon-gov::before {
+  background-color: var(--ogds-banner-icon-gov-color);
+  mask-image: var(--ogds-icon-gov);
+}
+
+.icon-https::before {
+  background-color: var(--ogds-banner-icon-https-color);
+  mask-image: var(--ogds-icon-https);
+}

package/src/components/usa-banner/usa-banner.spec.ts

@@ -0,0 +1,76 @@
+import { beforeEach, describe, expect, it } from "vitest";
+
+import "./index.js";
+
+function getInsideBanner(): ShadowRoot {
+  const banner = document.body.querySelector("usa-banner");
+  if (!banner) {
+    throw new Error("USA Banner element not found");
+  }
+  if (!banner.shadowRoot) {
+    throw new Error("USA Banner shadowRoot not found");
+  }
+  return banner.shadowRoot;
+}
+
+function getBannerButton(): HTMLButtonElement {
+  const button = getInsideBanner().querySelector(".usa-accordion__button");
+  if (!button) {
+    throw new Error("Banner button not found");
+  }
+  return button as HTMLButtonElement;
+}
+
+describe("USA Banner component", async () => {
+  beforeEach(async () => {
+    document.body.innerHTML = "<usa-banner></usa-banner>";
+  });
+
+  it("renders correctly", () => {
+    expect(getInsideBanner().textContent).toContain(
+      "An official website of the United States government",
+    );
+  });
+
+  it("uses gov TLD by default", () => {
+    expect(getInsideBanner().querySelector(".content")?.textContent).toContain(
+      ".gov",
+    );
+  });
+
+  it("initializes closed", () => {
+    expect(getBannerButton().ariaExpanded).toBe("false");
+  });
+
+  it("expands on button click", async () => {
+    const bannerButton = getBannerButton();
+
+    await bannerButton.click();
+
+    expect(bannerButton.ariaExpanded).toBe("true");
+  });
+});
+
+describe("Spanish variant", async () => {
+  beforeEach(async () => {
+    document.body.innerHTML = `<usa-banner lang="es"></usa-banner>`;
+  });
+
+  it("renders correctly", () => {
+    expect(getInsideBanner().textContent).toContain(
+      "Un sitio oficial del Gobierno de Estados Unidos",
+    );
+  });
+});
+
+describe("MIL variant", async () => {
+  beforeEach(async () => {
+    document.body.innerHTML = `<usa-banner tld="mil"></usa-banner>`;
+  });
+
+  it("renders correctly", () => {
+    expect(getInsideBanner().querySelector(".content")?.textContent).toContain(
+      ".mil",
+    );
+  });
+});

package/src/components/usa-banner/usa-banner.stories.ts

@@ -0,0 +1,136 @@
+import "./index";
+import ComponentDocs from "./docs.mdx";
+import { expect, userEvent, waitFor } from "storybook/test";
+import { within } from "shadow-dom-testing-library";
+import { getStorybookHelpers } from "@wc-toolkit/storybook-helpers";
+import type { Args, ArgTypes } from "storybook/internal/csf";
+
+const { argTypes, args, template } = getStorybookHelpers("usa-banner");
+
+const filteredArgTypes = (argTypes: ArgTypes) => {
+  const filtered: ArgTypes = {};
+
+  for (const [key, value] of Object.entries(argTypes)) {
+    // Disable methods and isOpen
+    if (value.table?.category === "methods" || key === "isOpen") {
+      filtered[key] = {
+        ...value,
+        table: {
+          ...value.table,
+          disable: true,
+        },
+      };
+    } else {
+      filtered[key] = value;
+    }
+  }
+
+  return filtered;
+};
+
+export default {
+  title: "Components/Banner",
+  component: "usa-banner",
+  tags: ["beta"],
+  args: {
+    ...args,
+    label: "",
+    tld: "gov",
+    lang: "en",
+  },
+  parameters: {
+    docs: {
+      page: ComponentDocs,
+    },
+  },
+  argTypes: filteredArgTypes(argTypes),
+  render: (args: Args) => template(args),
+};
+
+export const Default = {};
+
+export const CustomContent = {
+  argTypes: {
+    tld: { table: { disable: true } },
+    lang: { table: { disable: true } },
+  },
+  args: {
+    label: "Un site Web officiel du gouvernement américain",
+    /**
+     * The `getStorybookHelpers` function from @wc-toolkit/storybook-helpers`
+     * automatically appends the `slot` attribute to avoid collisions with other props.
+     *
+     * To set the content for this story, the key should have the suffix `-slot`,
+     * even though the slot name in the component is `banner-text`, `banner-action`, etc.
+     */
+    "banner-text-slot": "Un site Web officiel du gouvernement américain",
+    "banner-action-slot": "Voici comment vous le savez",
+    "domain-heading-slot": "Les sites Web officiels utilisent .gov",
+    "domain-text-slot":
+      "Un site Web .gov appartient à une organisation gouvernementale officielle aux États-Unis.",
+    "https-heading-slot": "Les sites Web .gov sécurisés utilisent HTTPS",
+    "https-text-slot": `Un <strong>verrou</strong> ( <span class="usa-banner__icon-lock" role="img" aria-label="Icône de cadenas verrouillé"></span> ) ou <strong>https://</strong> signifie que vous êtes connecté(e) en toute sécurité au site Web .gov. Assurez-vous de ne partager des informations sensibles que sur des sites Web officiels et sécurisés.`,
+  },
+};
+
+export const Mil = {
+  args: {
+    tld: "mil",
+  },
+};
+
+export const EspañolGov = {
+  args: {
+    lang: "es",
+  },
+};
+
+export const EspañolMil = {
+  args: {
+    lang: "es",
+    tld: "mil",
+  },
+};
+
+export const CustomThemeExample = {
+  parameters: {
+    docs: {
+      disable: true,
+    },
+  },
+  args: {
+    "--ogds-banner-background-color": "#0f191c", // blue-cool-90
+    "--ogds-banner-button-close-background-color": "#002d3f", // blue-cool-80-vivid
+    "--ogds-banner-focus-outline-color": "#52daf2", // cyan-20-vivid
+    "--ogds-banner-font-family":
+      "ui-monospace, 'Cascadia Code', 'Source Code Pro', Menlo, Consolas, 'DejaVu Sans Mono', monospace",
+    "--ogds-banner-link-hover-color": "#c3ebfa", // blue-cool-10-vivid
+    "--ogds-banner-text-color": "#ffffff",
+    "--ogds-banner-link-color": "#97d4ea", // blue-cool-20-vivid
+    "--ogds-banner-icon-gov-color": "#29e1cb", // mint-cool-20-vivid
+    "--ogds-banner-icon-https-color": "#29e1cb", // mint-cool-20-vivid
+  },
+};
+
+export const ToggleBannerTest = {
+  parameters: {
+    docs: {
+      disable: true,
+    },
+  },
+  play: async ({ canvasElement }: { canvasElement: HTMLElement }) => {
+    const canvas = within(canvasElement);
+    const button = canvas.getByShadowRole("button");
+    const dotGovText = canvas.getByShadowText("Official websites use .gov");
+
+    await userEvent.click(button);
+    await waitFor(() => {
+      expect(dotGovText).toBeVisible();
+    });
+
+    await userEvent.click(button);
+    await waitFor(() => {
+      expect(dotGovText).not.toBeVisible();
+    });
+  },
+};