Skip to Content
BBRICKSv0.7.4
Foundations

Words and labels

The copy system, overriding labels and the registries of keys.

Every word a component draws is in a keyed table, in English and Arabic. Nothing is written inline, so any word can be overridden, and the build of these docs can list them: each component page has a Labels table read from the component's own table.

Three levels

  1. Built in. The kit's words are CORE_COPY (keyed by component, in lib/copy.ts); the shell's are SHELL_COPY; each block and PR component keeps its own table beside it.
  2. The provider. BricksProvider labels={{ key: { en: {…}, ar: {…} } }} overrides any key, per language, merging with the built-in table. A preset can carry labels too (the TRNDR preset does, for the coupon chip, the score ring and "Managed by TRNDR").
  3. The component. Package components (shell, blocks, PR) also take their own labels or copy prop, which wins over the provider's.

Each level only has to give the keys it changes:

Three levels of override

A component's built-in words, then the provider's labels for that component and language, then the component's own labels prop (package components) or its language prop. Each level only has to give the keys it changes.

Code
import { BricksProvider, ListToolbar, Pager, ScoreRing, SaveBar, useLanguage } from '@ergasti/bricks';

function Levels() {
  const language = useLanguage();
  return (
    <div style={{ display: 'grid', gap: 18, maxWidth: 560 }}>
      <div><p className="kit-muted">Built in</p><SaveBar dirty onSave={() => {}} onDiscard={() => {}} /></div>
      <BricksProvider labels={{ saveBar: { en: { save: 'Publish' }, ar: { save: 'انشر' } } }}>
        <div><p className="kit-muted">Provider: labels.saveBar.{language}.save</p><SaveBar dirty onSave={() => {}} onDiscard={() => {}} /></div>
      </BricksProvider>
      <div>
        <p className="kit-muted">A function word: pager.showing takes (from, to, total)</p>
        <BricksProvider labels={{ pager: { en: { showing: (from, to, total) => `${from} to ${to} of ${total} creators` } } }}>
          <Pager page={2} lastPage={5} total={46} perPage={10} loading={false} label="Creators" onPage={() => {}} />
        </BricksProvider>
      </div>
      <div style={{ display: 'flex', gap: 24 }}>
        <ScoreRing value={74} />
        <BricksProvider labels={{ scoreRing: { en: { label: 'Creator score', title: (n) => `Creator score ${n} / 100` }, ar: { label: 'تقييم الصانع', title: (n) => `تقييم الصانع: ${n} من 100` } } }}><ScoreRing value={74} /></BricksProvider>
      </div>
      <ListToolbar reset={{ active: true, onReset: () => {} }} />
    </div>
  );
}

A word is either a string or a function that takes values and returns a string (showing: (from, to, total) => …). The Labels table on a component page shows a function word with the names of its values in braces, for example Showing {from}–{to} of {total}.

Keys

The provider's labels has one key per component. There are two sets: the kit's keys (KitCopyKey, the keys of CORE_COPY) and the packages' keys (PackageCopyKey: shell, brand blocks and PR blocks). The two sets never overlap (a compile-time check). The table lists each key and the component pages that read it.

133 keys: 32 kit keys and 101 package keys, found by reading each component's source for useCopy and usePackageCopy.

KeySetWordsRead by
asyncBlockKit1AsyncBlock
avatarStackKit2AvatarStack, BrandStack
bulkBarKit3BulkBar
buttonLinkKit1ButtonLink
chartsKit1shared by several components
copyLinkKit3CopyLink
couponChipKit3CouponChip
dataTableKit7DataTable
deltaKit3Delta
dialogKit2DialogSkeleton
followersCellKit1FollowersCell
heroCardKit6HeroCard
keyValueKit1KeyValue
listStateKit2ListState
listToolbarKit6ListToolbar
moneyNoteKit4MoneyNote
notificationsKit10NotificationsMenu
pagerKit7Pager
personCellKit1CreatorCell, PersonCell
platformsKit3FollowersCell, PlatformPill
proofButtonKit3ProofButton
proofListKit1ProofList
rankMedalKit1RankMedal
ringKit1Ring
rowListKit2RowList
saveBarKit4SaveBar
scoreRingKit2ScoreRing
shareBarKit1ShareBar
sortSelectKit1SortSelect
stepTimelineKit3StepTimeline
toastKit1ToastRegion
toolbarKit1Toolbar
activityLogPackage3ActivityLog
bonusCardPackage4BonusCard, BonusDetail
bundleCardPackage8BundleCard
bundleGridPackage2BundleGrid
bundlePurchaseSummaryPackage16BundlePurchaseSummary
bundleResultBannerPackage6BundleResultBanner
challengeCardPackage11ChallengeCard, ChallengeDetail
challengeDetailPackage7ChallengeDetail
challengeRequestFormPackage42ChallengeRequestForm
commissionInputPackage13CommissionInput, CommissionRate
copyLinkFieldPackage4CopyLinkField
creatorProfilePanelPackage16CreatorProfilePanel, ScoreCard
defaultableSettingPackage16DefaultableSetting
findCreatorCardPackage9FindCreatorCard, FollowerLine
giftProductsPickerPackage10GiftProductsPicker
giftRulesCardPackage18GiftRulesCard
giftStockListPackage7GiftStockList
groupCardPackage4GroupCard, GroupPanel
groupFormPackage9GroupForm
groupPanelPackage15GroupPanel
liveChallengeCardPackage8LiveChallengeCard
membersPickerPackage5MembersPicker
messageHistoryItemPackage24MessageHistoryItem
messageHistoryListPackage7MessageHistoryList
messagesPanelPackage7MessagesPanel
myCreatorPanelPackage16MyCreatorPanel
payoutBatchDetailPackage11PayoutBatchDetail
payoutWindowCardPackage4PayoutWindowCard
prAdjustWalletPackage12AdjustWalletDialog
prAnnouncementComposerPackage9AnnouncementComposer
prApprovalsPackage12ApprovalActions, ApprovalRow, QueueHeader, WaitingCell
prAudiencePickerPackage20AudiencePicker
prBrandDetailPackage20BrandDetailHeader, BrandWalletCard, ViewAsBanner
prBrandFeePackage11BrandFeeDialog
prBrandGiftStockPackage7BrandGiftStock
prBrandRequestPackage11BrandRequestCard
prBuilderStepPackage5BuilderStepCard
prBulkBarPackage3PrBulkBar
prCampaignChallengesPackage7CampaignChallenges
prChallengeBuilderPackage61ChallengeAudienceFields, ChallengeBasicsFields, ChallengeRewardFields
prChallengeCardPackage19PrChallengeCard
prChallengeGiftPickerPackage10ChallengeGiftPicker
prChallengeStatusFilterPackage2ChallengeStatusFilter
prChallengeSummaryPackage46ChallengeSummary, SummarySection
prChangeOwnerPackage10ChangeOwnerDialog
prChangeRequestsPackage13CampaignChangeRequests
prChannelPickerPackage4ChannelPicker
prCommissionChangePackage17CommissionChangeForm
prCountPillPackage3PrCountPill
prCreatorDrawerPackage24PrCreatorDrawer
prCreatorPickPackage11CreatorPickDialog
prCustomerCardPackage28CustomerAffiliatesCard
prCustomerSwitchPackage11CustomerAffiliatesSwitch
prDecisionsCardPackage3DecisionsCard
prDecisionTagPackage2DecisionTag
prEditingPackage6ChangePreview, Stepper
prFraudCaseDetailPackage30FraudCaseDetail
prFraudCaseRowPackage11FraudCaseRow
prFraudDecisionPackage13FraudDecisionBar
prGiftAnalyticsPackage10GiftShipmentCounts
prGiftAttentionPackage4GiftAttentionList
prGiftsPackage45GiftClaimCheck, ShipmentSummary
prGiftShipmentPackage31GiftShipmentCard
prGiftSidePackage13BrandGiftStockCard, GiftShipmentTimeline
prGiftStatusFilterPackage2GiftStatusFilter
prLeaderboardPackage23Leaderboard
prLoginCardPackage12LoginCard
prLoginLayoutPackage4LoginLayout
prMessageCellsPackage7AudienceLabel, OpenRate, SenderCell
prMessageDrawerPackage10MessageDrawer
prMessageFieldsPackage8MessageFields
prMessagePreviewPackage8MessagePreview
prMiniListPackage2MiniList, MiniRow
prNextCampaignPackage19NextCampaignCard, ScheduleCampaignDialog
productCellPackage1ProductCell
progressRowPackage2ProgressRow
prOtpStepPackage11OtpStep
prPermissionMatrixPackage4PermissionMatrix
prPortalFramePackage20PrPortalFrame
prProgramCardsPackage15AffiliateProgramCard, ProgramStatusCard
prReasonDialogPackage9ReasonDialog
prReceiptUploadPackage15ReceiptUpload
prRecordGiftsPackage18RecordGiftsDialog
prRequestCardsPackage13RequestGiftsCard, RequestHandled, RequestWalletCard
prRequestChallengePackage4RequestChallengeCard
prScorePackage28ScoreBreakdown, ScoreExplainer
prSenderPickerPackage5SenderPicker
prSettingsPackage5NumberSetting, PlatformDefaultRow
prTierChangePackage13TierChangeDialog
prTierLadderPackage41TierLadder
prTierMovesPackage8TierMoveList
prUsageBarPackage1UsageBar
prWalletHealthPackage4WalletHealthPill
prWarehousePackage14WarehouseDetailsCard, WarehouseNote
rowActionsPackage8RowActions
settingsSectionPackage2SettingsSection
specialCommissionFormPackage10SpecialCommissionForm
topUpAmountPickerPackage12TopUpAmountPicker
topUpResultBannerPackage5TopUpResultBanner
walletHealthCardPackage14WalletHealthCard
walletLedgerPackage9WalletLedger

CORE_COPY

constant

The generic defaults. Words that name a brand (TRNDR score, Managed by TRNDR) are in the preset instead.

const CORE_COPY: KitCopyTable

Source: src/lib/copy.ts (line 130)

SHELL_COPY

constant

The shell's built-in words in English and Arabic (menu, close, skip link, usage meter and so on), keyed by language. AppShell and its parts read them; override per component with BricksProvider labels or their own props.

const SHELL_COPY: Readonly<Record<Lang, { skipToMain: string; sidebar: string; bottomNav: string; navSheet: string; menu: string; close: string; closeMenu: string; expandSidebar: string; collapseSidebar: string; more: string; breadcrumbs: string; otherLanguage: string; otherLanguageShort: string; searchLabel: string; searchPlaceholder: string; searchNone: string; searchFailed: string; searchLoading: string; errorText: string; retry: string; signOut: string; account: string; accountSuffix: string; usageNoLimit: string; usageOf: (used: string, limit: string) => string; }>>

Source: src/shell/copy.ts (line 69)

Wording rules the library follows

  • Words that name a brand (a product name, a currency) live in a preset, never in the generic tables.
  • No inline language ternaries: a guard test fails on language === 'ar' ? '…' : '…'.
  • Say the outcome in a toast ("Approved. Sara gets a WhatsApp."), and write validation messages as the next step.

Labels in lists

labelText(label, language) resolves a label that is either a plain string or an { en, ar } pair; the shell's navigation uses it.

labelText

function

The label in language.

function labelText(label: NavLabel, language: Lang): string

Prop

Type

Source: src/shell/types.ts (line 9)

On this page