@12-apps/ui 6.7.0 → 6.9.0

package/src/copy.ts

@@ -11,179 +11,18 @@
  * The DataViews family has its own object (`DataViewsCopy`) threaded through a
  * context, because nineteen files are one mounted surface. These six are
  * mounted independently, so each takes what it renders.
- */
-
-export interface SectionOnboardingCopy {
-  /** The button that begins the guided section. */
-  start: string;
-  /** The reveal toggle in the configured state, and its collapsed twin. */
-  edit: string;
-  collapse: string;
-}
-
-export interface ConfirmActionCopy {
-  /** The dismiss button every confirmation shares. */
-  cancel: string;
-  /** Shown when the action fails and the caller supplied no reason. */
-  defaultError: string;
-  /**
-   * The fallback body when the caller names no entity.
-   *
-   * A caller that DOES name one gets the host's own sentence — this package
-   * never guesses a noun for someone else's rows.
-   */
-  irreversible: string;
-  /**
-   * The typed-confirmation prompt, naming the exact word that unlocks the
-   * button. A function because where that word sits in the sentence, and how
-   * it is quoted, is the translator's call.
-   */
-  typeToConfirm(expected: string): string;
-}
-
-export interface CategorySelectCopy {
-  /**
-   * What categories are FOR, in the host's own terms.
-   *
-   * This used to read "Categorias organizam o cardápio e os filtros da loja" —
-   * a restaurant's menu, hard-coded into a generic picker. A host selling
-   * insurance policies got told about its cardápio.
-   */
-  purpose: string;
-  clearSelection: string;
-  /**
-   * The quick actions above the tree. Each toggles as a PAIR, and each label
-   * says what pressing it will do rather than what state the list is in — so a
-   * translator needs both halves, not one plus a negation.
-   */
-  selectAll: string;
-  deselectAll: string;
-  expandAll: string;
-  collapseAll: string;
-  /**
-   * ONE row's chevron, in its two states — a glyph button inside the row
-   * button, so this pair is the whole of what a screen reader reads for it.
-   * The category's own name is appended by the caller.
-   */
-  expandCategory(name: string): string;
-  collapseCategory(name: string): string;
-  /**
-   * What the closed control invites, and it differs by mode: picking ONE
-   * category is a move, picking several is a filter. Both were pt-BR defaults
-   * behind an optional prop, which is the arrangement this port removes.
-   */
-  placeholderSingle: string;
-  placeholderMulti: string;
-  /** The empty state, when the host has no categories at all. */
-  emptyTitle: string;
-  createCategory: string;
-  /**
-   * The search found nothing.
-   *
-   * Two of the four interpolate the term typed, so they are functions rather
-   * than strings with a placeholder to substitute: where the term sits in the
-   * sentence is the translator's call, not ours.
-   */
-  noResults: {
-    title: (query: string) => string;
-    hint: string;
-    clearSearch: string;
-    create: (query: string) => string;
-  };
-  /**
-   * The panel's two footers.
-   *
-   * `selectedCount` is a function because Portuguese agrees the participle with
-   * the count and English does not — the shape has to let a translator decide
-   * the whole sentence, not fill a slot in ours.
-   */
-  /** The search box above the list, and the chips beneath it. */
-  search: {
-    /** Two placeholders: a single-select picker offers no subcategories. */
-    placeholderSingle: string;
-    placeholderMulti: string;
-    clear: string;
-    removeChip(label: string): string;
-    /** The tray above the list, counting what is already picked. */
-    pinnedLabel(count: number): string;
-  };
-  footer: {
-    selectedCount(count: number): string;
-    clear: string;
-    /** The primary button, which reads `close` while the draft is unchanged. */
-    apply: string;
-    close: string;
-    /** The single-select footer: what to do, and the way out. */
-    singleHint: string;
-    cancel: string;
-  };
-}
-
-export interface CepFieldCopy {
-  loading: string;
-  found: string;
-  /** Keyed to match `CepLookupStatus` exactly, so the lookup can index it. */
-  notfound: string;
-}
-
-export interface TableFilterCopy {
-  /** A numeric range whose maximum is below its minimum. */
-  invalidRange: string;
-  /** The two free-text bounds, which carry no visible label of their own. */
-  rangeMin: string;
-  rangeMax: string;
-}
-
-/**
- * The lightbox's controls, every one of them a glyph with no text.
  *
- * So this object IS what a screen-reader user hears for the whole viewer —
- * which is why it shipped as English literals for so long without anyone
- * noticing: the sighted path renders identically either way.
+ * This file is a BARREL over `./copy/`, one module per component family. It was
+ * one file until the port made it 411 lines against this package's own 400-line
+ * budget — and a single list of every family is exactly the file that grows on
+ * every port, so the budget would have been the thing that gave way next.
+ * Consumers are unaffected: `@12-apps/ui/copy` still resolves here.
  */
-export interface LightboxCopy {
-  close: string;
-  previous: string;
-  next: string;
-  zoomIn: string;
-  zoomOut: string;
-  resetZoom: string;
-  /** The slideshow toggle, in its two states. */
-  play: string;
-  pause: string;
-}
-
-/** The map preview's control bar — same shape, same reason, as the lightbox. */
-export interface MapPreviewCopy {
-  zoomIn: string;
-  zoomOut: string;
-  center: string;
-  mapType: string;
-  fullscreen: string;
-  search: string;
-}
-
-/** The carousel's two arrows, which carry a glyph and nothing else. */
-export interface CarouselCopy {
-  previous: string;
-  next: string;
-}
 
-/**
- * The states a data surface can be in with nothing to draw, and the dismiss
- * every banner-like surface carries.
- *
- * One object rather than six, because these are the same four sentences the
- * table, the grid, the async container, the hover card and the infinite
- * scroller each rendered their own copy of.
- */
-export interface DataStateCopy {
-  /** No rows at all — distinct from "no rows for these filters". */
-  empty: string;
-  loading: string;
-  /** The infinite scroller reached the end. */
-  endOfList: string;
-  /** An alert's and a banner's dismiss, neither of which has a visible label. */
-  dismissAlert: string;
-  dismissBanner: string;
-}
+export type * from './copy/data-display';
+export type * from './copy/feedback';
+export type * from './copy/form';
+export type * from './copy/layout';
+export type * from './copy/navigation';
+export type * from './copy/shared';
+export type * from './copy/utility';

package/src/en-US.data-display.ts

@@ -0,0 +1,244 @@
+/**
+ * The en-US pack for the data-display family. Split the same way
+ * `pt-BR.data-display.ts` is — see `en-US.ts` for why.
+ */
+import type { DataViewsCopy } from "./components/data-display/DataViews/data-views-copy";
+import type {
+  CarouselCopy,
+  DataStateCopy,
+  LightboxCopy,
+  MapPreviewCopy,
+  TimingDiagramCopy,
+} from './copy';
+import { EN_US_TABLE_FILTER_COPY } from './en-US.layout';
+import {
+  EN_US_CATEGORY_SELECT_COPY,
+  EN_US_CONFIRM_ACTION_COPY,
+  EN_US_SAVED_VIEWS_LABELS,
+} from './en-US.shared';
+
+export const EN_US_LIGHTBOX_COPY: LightboxCopy = {
+  close: "Close",
+  previous: "Previous",
+  next: "Next",
+  zoomIn: "Zoom in",
+  zoomOut: "Zoom out",
+  resetZoom: "Reset zoom",
+  play: "Start the slideshow",
+  pause: "Pause the slideshow",
+};
+
+export const EN_US_MAP_PREVIEW_COPY: MapPreviewCopy = {
+  zoomIn: "Zoom in",
+  zoomOut: "Zoom out",
+  center: "Centre the map",
+  mapType: "Change the map type",
+  fullscreen: "Full screen",
+  search: "Search for an address",
+};
+
+export const EN_US_CAROUSEL_COPY: CarouselCopy = {
+  previous: "Previous",
+  next: "Next",
+};
+
+export const EN_US_TIMING_DIAGRAM_COPY: TimingDiagramCopy = {
+  regionLabel: "Timing diagram",
+  heading: "Request timing",
+};
+
+export const EN_US_DATA_STATE_COPY: DataStateCopy = {
+  empty: "Nothing here",
+  loading: "Loading…",
+  endOfList: "No more items to load",
+  dismissAlert: "Dismiss",
+  dismissBanner: "Dismiss this banner",
+};
+
+export const EN_US_DATA_VIEWS_COPY: DataViewsCopy = {
+  savedViewsMenu: EN_US_SAVED_VIEWS_LABELS,
+  confirmAction: EN_US_CONFIRM_ACTION_COPY,
+  categorySelect: EN_US_CATEGORY_SELECT_COPY,
+  board: {
+    countOnPage: (label, count) => `${label}: ${count} on this page`,
+    onThisPage: (count) => `${count} on this page`,
+    pageSum: (sum) => `This page totals ${sum}`,
+    emptyColumn: "Nothing at this stage",
+    pageScopeNote: "The counts and totals below cover only the items on this page.",
+  },
+  deleteView: {
+    title: "Delete view",
+    target: (viewName) => `Delete "${viewName}"?`,
+    sharedWarning: "This view is shared — the team will lose access to it.",
+    // `entityLabel` is the HOST's word for what the rows are, so the sentence is
+    // built around it rather than naming a noun of its own.
+    rowsUnaffected: (entityLabel) =>
+      `${entityLabel} are not affected; only the saved slice is removed.`,
+    confirm: "Delete view",
+    cancel: "Cancel",
+  },
+  manageViews: {
+    title: "Manage views",
+    empty: "No saved views.",
+    edit: "Edit",
+    defaultTag: "Default",
+    otherUserTag: "Another user's",
+    deleteTitle: "Delete this saved view?",
+    deleteBody: "The filters and columns it holds are lost. This cannot be undone.",
+    deleteConfirm: "Delete",
+  },
+  saveView: {
+    sharedDescription: "Anyone in the store will be able to open and use this view.",
+    setDefaultTitle: "Set as default",
+    setDefaultDescription: "This screen opens on this view instead of the Main view.",
+    previewHeading: "What this view holds",
+    previewUnchanged: "Nothing has changed — this view will match the Main view.",
+    sortRowLabel: "Sorting",
+    saveFailed: "Could not save the view.",
+    titleEditing: "Edit view",
+    titleCreating: "Save view",
+    descriptionLabel: "Description — optional",
+    descriptionPlaceholder: "What this view is for",
+    submitEditing: "Save changes",
+    submitCreating: "Save view",
+    nameLabel: "Name",
+    cancel: "Cancel",
+    pinnedTitle: "Pin to the sidebar",
+    pinnedDescription: "Appears as a shortcut in the menu, under this screen.",
+    sharedTitle: "Share with the team",
+    namePlaceholder: "e.g. Declined card payments this week",
+    previewFilters: "Filters",
+    previewHiddenColumns: "Hidden columns",
+  },
+  columns: {
+    visibleCount: (visible, total) => `${visible} of ${total} visible`,
+    reset: "Default",
+    showAll: "Show all",
+    dragHint: "Drag to reorder the columns.",
+    moveUp: (columnLabel) => `Move ${columnLabel} up`,
+    moveDown: (columnLabel) => `Move ${columnLabel} down`,
+  },
+  display: {
+    sortTab: "Sort",
+    columnsTab: "Columns",
+    panelTab: "Display",
+    direction: "Direction",
+    layoutHints: {
+      table: "Comparable columns, good for scanning numbers.",
+      list: "One row per item, with the key fields.",
+      cards: "Larger blocks, good for a handful of items.",
+      board: "A column per stage, for tracking what is where.",
+    },
+    densityHeadings: {
+      table: "Row height",
+      list: "Row height",
+      cards: "Cards per row",
+      board: "Column width",
+    },
+    densityLabels: {
+      table: { compact: "Low", cozy: "Medium", comfortable: "High" },
+      list: { compact: "Low", cozy: "Medium", comfortable: "High" },
+      cards: { compact: "Many", cozy: "Some", comfortable: "Few" },
+      board: { compact: "Narrow", cozy: "Medium", comfortable: "Wide" },
+    },
+    boardUnavailable: "This screen declares no stages, so it offers no board.",
+    densityUnavailableNarrow:
+      "One card per row at this width — density returns on larger screens.",
+    trigger: "Display",
+    fieldHeading: "Field",
+    formatHeading: "Format",
+    cardZoom: "Card size",
+  },
+  export: {
+    formats: {
+      // The extension is the file's, not a word: it stays as it is written on
+      // disk in every language.
+      json: { label: "JSON (.json)", hint: "For integrations" },
+    },
+    visibleColumns: (columnCount) => `${columnCount} visible columns, in their current order`,
+    trigger: "Export",
+    triggerLabel: "Export",
+  },
+  tableFilter: EN_US_TABLE_FILTER_COPY,
+  grid: {
+    rowActions: "Actions",
+    bulkActions: (selectedCount) => `Actions (${selectedCount}) ▾`,
+    emptyFilteredTitle: "No results for these filters",
+    emptyFilteredHint: "Adjust or remove the filters.",
+    emptyFilteredAction: "Clear filters",
+  },
+  filters: {
+    moreFilters: (count) => `More filters: ${count} did not fit in the bar`,
+    moreFiltersApplied: (count, appliedCount) =>
+      `More filters: ${count} did not fit in the bar, ${appliedCount} applied`,
+    moreTriggerLabel: "More",
+    moreHeading: "More filters",
+    overflowNote: "did not fit in the bar",
+    rangeEnd: "To",
+    rangeInvalid: "The start must be earlier than the end.",
+    rangeInclusiveNote: "Both dates are included in the result.",
+    rangeStart: "From",
+    // The mask is what the reader TYPES, so it follows their own date order
+    // rather than being carried over. A translated label above an unchanged
+    // mask is the shape that gets a date entered backwards.
+    dayMask: "mm/dd/yyyy",
+    clearAllFilters: "Clear all filters",
+    // The KEYS are the package's own preset ids and stay as they are — the
+    // surface matches on them. Only the labels beside them are words.
+    rangePresets: {
+      hoje: "Today",
+      ontem: "Yesterday",
+      semana: "This week",
+      mes: "This month",
+      ano: "This year",
+    },
+    scopesLabel: "Status",
+    panelTitle: "Filters",
+    clear: "Clear",
+    clearAll: "Clear filters",
+    clearRange: (label) => `Clear ${label}`,
+    allOption: "All",
+    optionSearchPlaceholder: "Search…",
+    optionsEmpty: "No results",
+    optionsHeading: "Options",
+  },
+  selection: {
+    selectAllOnPage: "Select all on this page",
+    clearSelection: "Clear selection",
+    selectAll: "Select all",
+    onThisPage: (count) => `${count} on this page`,
+    selectRow: "Select",
+    expandRow: "Expand details",
+    collapseRow: "Collapse details",
+  },
+  nav: {
+    mainView: "Main view",
+    defaultTag: "Default",
+    viewOptions: (viewName) => `${viewName} options`,
+    emptyHint: "No saved views. Adjust filters, columns or sorting and save below.",
+    setDefault: "Set as default",
+    deleteView: "Delete view",
+    unsavedChanges: "Unsaved changes",
+    label: "View",
+    update: "Update view",
+    save: "Save view",
+    saveAs: "Save as new",
+    reset: "Reset",
+    updateFailed: "Could not update the view",
+    dismissError: "Dismiss",
+    goBack: "Back",
+    pageSize: "Show:",
+    saveFailed: "Could not save the change to the view.",
+    editView: "Rename and edit",
+    pinToSidebar: "Pin to the sidebar",
+    shareWithTeam: "Share with the team",
+  },
+  search: {
+    placeholder: "Search…",
+    allColumnsLabel: "Search every column",
+    keywordPlaceholder: "Press Enter to filter",
+    open: "Search",
+    close: "Close search",
+    clear: "Clear search",
+  },
+};

package/src/en-US.feedback.ts

@@ -0,0 +1,25 @@
+/**
+ * The en-US pack for the feedback family. Split the same way
+ * `pt-BR.feedback.ts` is — see `en-US.ts` for why.
+ */
+import type {
+  ChromeCopy,
+  TutorialCopy,
+} from './copy';
+
+export const EN_US_TUTORIAL_COPY: TutorialCopy = {
+  skip: "Skip",
+  previous: "Back",
+  next: "Next",
+  restart: "Start over",
+};
+
+export const EN_US_CHROME_COPY: ChromeCopy = {
+  dismissToast: "Dismiss",
+  goBack: "Back",
+  closePanel: "Close",
+  closeTab: "Close tab",
+  scrollRegion: "Scrollable content",
+  scrollToTop: "Back to top",
+  share: "Share",
+};

package/src/en-US.form.ts

@@ -0,0 +1,103 @@
+/**
+ * The en-US pack for the form family. Split the same way `pt-BR.form.ts` is —
+ * see `en-US.ts` for why.
+ */
+import type {
+  AddressAutocompleteCopy,
+  AutocompleteCopy,
+  CodeEditorCopy,
+  PasswordStrengthCopy,
+  PhoneInputCopy,
+  RichEditorToolbarCopy,
+  UploadButtonCopy,
+} from './copy';
+
+export const EN_US_ADDRESS_AUTOCOMPLETE_COPY: AddressAutocompleteCopy = {
+  loadingMaps: "Loading Google Maps…",
+  mapsLoadFailed:
+    "Could not load the Google Maps API. Check the API key and the internet connection.",
+  useCurrentLocation: "Use my current location",
+};
+
+export const EN_US_AUTOCOMPLETE_COPY: AutocompleteCopy = {
+  loading: "Loading…",
+  noResults: "No results found",
+  placeholder: "Type to search…",
+};
+
+export const EN_US_CODE_EDITOR_COPY: CodeEditorCopy = {
+  loading: "Loading the editor…",
+  readOnly: "Read only",
+  // The shortcut is the editor's own binding and is not translated — it is what
+  // the reader must press, not something they read.
+  formatCode: "Format code (Ctrl+Shift+F)",
+  enableWrap: "Wrap lines",
+  disableWrap: "Do not wrap lines",
+  copyToClipboard: "Copy to clipboard",
+  copied: "Copied!",
+  enterFullscreen: "Full screen",
+  exitFullscreen: "Leave full screen",
+};
+
+export const EN_US_PASSWORD_STRENGTH_COPY: PasswordStrengthCopy = {
+  strengthHeading: "Password strength",
+  requirementsHeading: "Requirements:",
+  suggestionsHeading: "Suggestions:",
+  bands: {
+    veryWeak: "Very weak",
+    weak: "Weak",
+    fair: "Fair",
+    good: "Good",
+    strong: "Strong",
+  },
+  requirements: {
+    // The count is the HOST's configured minimum, interpolated rather than
+    // written out: a host raising it must not end up with a requirement naming
+    // the old number.
+    minLength: (count) => `At least ${count} characters`,
+    uppercase: "One uppercase letter",
+    lowercase: "One lowercase letter",
+    numbers: "One number",
+    special: "One special character",
+  },
+  suggestions: {
+    minLength: (count) => `Use at least ${count} characters`,
+    uppercase: "Add uppercase letters",
+    lowercase: "Add lowercase letters",
+    numbers: "Include numbers",
+    special: "Add special characters",
+  },
+};
+
+export const EN_US_RICH_EDITOR_TOOLBAR_COPY: RichEditorToolbarCopy = {
+  bold: "Bold",
+  italic: "Italic",
+  underline: "Underline",
+  bulletList: "Bulleted list",
+  numberedList: "Numbered list",
+  quote: "Quote",
+  code: "Code",
+  insertLink: "Insert link",
+  textColor: "Text colour",
+  backgroundColor: "Background colour",
+  linkPrompt: "Enter the URL:",
+};
+
+export const EN_US_PHONE_INPUT_COPY: PhoneInputCopy = {
+  selectCountry: "Select country",
+  invalidNumber: (countryName) => `Not a valid phone number for ${countryName}`,
+  // Substituted into the sentence above when no country is chosen, so it has to
+  // read as a noun phrase inside it rather than as a sentence of its own.
+  unknownCountry: "the selected country",
+};
+
+export const EN_US_UPLOAD_BUTTON_COPY: UploadButtonCopy = {
+  buttonLabel: "Upload a file",
+  dropzoneHint: "Drop the file here, or click to choose one",
+  dropzoneRole: (label) => `File upload area. ${label}`,
+  uploading: "Uploading…",
+  dropReady: "File ready to drop",
+  percentUploaded: (percent) => `${percent}% uploaded`,
+  uploadInProgress: (percent) => `Upload in progress: ${percent}%`,
+  errorAnnouncement: (message) => `Error: ${message}`,
+};

package/src/en-US.layout.ts

@@ -0,0 +1,15 @@
+/**
+ * The en-US pack for the layout family. Split the same way `pt-BR.layout.ts`
+ * is — see `en-US.ts` for why the packs live in per-family files.
+ */
+import type {
+  TableFilterCopy,
+} from './copy';
+
+export const EN_US_TABLE_FILTER_COPY: TableFilterCopy = {
+  clearAllFilters: "Clear all filters",
+  clearKeyword: "Clear the search",
+  invalidRange: "The maximum must be greater than or equal to the minimum.",
+  rangeMin: "Minimum",
+  rangeMax: "Maximum",
+};

package/src/en-US.navigation.ts

@@ -0,0 +1,23 @@
+/**
+ * The en-US pack for the navigation family. Split the same way
+ * `pt-BR.navigation.ts` is — see `en-US.ts` for why.
+ */
+import type {
+  BreadcrumbCopy,
+  CommandPaletteCopy,
+} from './copy';
+
+export const EN_US_COMMAND_PALETTE_COPY: CommandPaletteCopy = {
+  execute: "Run",
+  // The arrow glyphs and the key name are part of the hint a reader looks at
+  // while their hands are on the keyboard, so they survive translation intact.
+  navigate: "↑↓ Navigate",
+  close: "ESC Close",
+  recent: "Recent",
+  tryAnotherTerm: "Try another term",
+};
+
+export const EN_US_BREADCRUMB_COPY: BreadcrumbCopy = {
+  showMore: "Show more",
+  moreItems: "More items",
+};