Code Documentation for ftu-ui-components
  1. Miscellaneous
  2. Variables

Index

/home/workflows/workspace/libs/design-system/cards/action-card/src/lib/action-card.definition.ts

ActionCardDef
Type : ContentTemplateDef<ActionCardComponent>
Default value : { component: ActionCardComponent, spec: ActionCardSchema, projectedProperties: { '*': 'content', "hra-action-card-action:not([alignment='right'])": 'actionsLeft', "hra-action-card-action[alignment='right']": 'actionsRight', }, }

Content template definition for action card

/home/workflows/workspace/libs/design-system/cards/action-card/src/lib/action-card.schema.ts

ActionCardSchema
Type : unknown
Default value : ContentTemplateSchema.extend({ component: z.literal('ActionCard'), variant: ActionCardVariantSchema, tagline: z.string(), subtagline: z.string().optional(), image: z.string().optional(), icons: IconListSchema.optional(), content: ProjectedContentTemplateSchema.optional(), actionsLeft: ProjectedContentTemplateSchema.optional(), actionsRight: ProjectedContentTemplateSchema.optional(), })

Schema for content template action card data
ActionCardVariantSchema
Type : unknown
Default value : z.enum(['elevated', 'flat', 'outlined', 'outlined-with-icons'])

Schema for action card variants

/home/workflows/workspace/libs/design-system/navigation/site-navigation/src/lib/utils/match-options.ts

ACTIVE_MATCH_OPTIONS
Type : IsActiveMatchOptions
Default value : { paths: 'exact', matrixParams: 'ignored', queryParams: 'ignored', fragment: 'ignored', }

Options for active link matching

/home/workflows/workspace/libs/design-system/content-templates/api-command/src/lib/api-command.schema.ts

ApiCommandButtonSchema
Type : unknown
Default value : z.object({ /** Text for the plain button */ label: z.string(), /** Icon name for the button */ icon: z.string().optional(), /** External URL for the button */ url: z.string().url().optional(), })

Schema representing the details of an api command button
ApiCommandSchema
Type : unknown
Default value : ContentTemplateSchema.extend({ component: z.literal('ApiCommand'), /** API request url to be displayed in the card */ request: z.string(), /** Can be GET or POST */ method: z.enum(['GET', 'POST']), /** Details of the right button */ rightButton: ApiCommandButtonSchema, })

Schema for api command

/home/workflows/workspace/libs/design-system/content-templates/api-command/src/lib/api-command.definition.ts

ApiCommandDef
Type : ContentTemplateDef<ApiCommandComponent>
Default value : { component: ApiCommandComponent, spec: ApiCommandSchema, }

Content template definition for ApiCommandComponent

/home/workflows/workspace/libs/design-system/expansion-panel/src/lib/expansion-panel-animations.ts

BODY_EXPANSION
Type : unknown
Default value : trigger('bodyExpansion', [ state('collapsed, void', style({ height: '0px', visibility: 'hidden', opacity: 0 })), state('expanded', style({ height: '*', visibility: '', opacity: 1 })), transition('expanded <=> collapsed, void => collapsed', animate(EXPANSION_PANEL_ANIMATION_TIMING)), ])

Animation for Body Expansion
EXPANSION_PANEL_ANIMATION_TIMING
Type : string
Default value : '225ms cubic-bezier(0.4,0.0,0.2,1)'

Animation for the expansion panel

/home/workflows/workspace/libs/design-system/brand/logo/src/lib/types/logos.schema.ts

BrandLogoSchema
Type : unknown
Default value : z.object({ size: BrandLogoSizeSchema, src: z.string(), width: z.number().positive(), height: z.number().positive(), })

Schema for logo item
BrandLogoSizeSchema
Type : unknown
Default value : z.enum(['small', 'regular'])

Schema for logo size
BrandLogosSchema
Type : unknown
Default value : z.object({ $schema: z.string(), logos: BrandLogoSchema.array(), })

Schema for logos

/home/workflows/workspace/libs/design-system/brand/mark/src/lib/types/marks.schema.ts

BrandMarkSchema
Type : unknown
Default value : z.object({ variant: BrandMarkVariantSchema, src: z.string(), width: z.number().positive(), height: z.number().positive(), })

Schema for mark item
BrandMarksSchema
Type : unknown
Default value : z.object({ $schema: z.string(), marks: BrandMarkSchema.array(), })

Schema for marks
BrandMarkVariantSchema
Type : unknown
Default value : z.enum(['default', 'contrast', 'small'])

Schema for mark variant

/home/workflows/workspace/libs/design-system/buttons/button/src/lib/types/button.definition.ts

ButtonDef
Type : ContentTemplateDef<ButtonComponent>
Default value : { component: ButtonComponent, spec: ButtonSchema, }

Content template definition for DataViewerComponent

/home/workflows/workspace/libs/design-system/buttons/button/src/lib/types/button.schema.ts

ButtonSchema
Type : unknown
Default value : ContentTemplateSchema.extend({ component: z.literal('Button'), label: z.string(), href: z.string(), type: z.enum(['default', 'flat', 'cta', 'fab']).optional(), variant: z.enum(['primary', 'secondary']).optional(), size: z.enum(['small', 'medium']).optional(), disabled: z.boolean().optional(), icon: z.string().optional(), })

HRA button schema

/home/workflows/workspace/libs/design-system/privacy/privacy-preferences/src/lib/categories/category-defs.ts

CATEGORY_DEFS
Type : CategoryDef[]
Default value : [ { id: EventCategory.Necessary, title: 'Necessary', description: `Necessary cookies and similar technologies make websites usable by enabling basic functions like page navigation. The website cannot function properly without this feature.`, provider: 'Human Reference Atlas', providerLink: 'https://humanatlas.io/privacy-policy', required: true, }, { id: EventCategory.Preferences, title: 'Preferences', description: `Preference cookies remember your choices, like your preferred language or display settings. They help the site behave in a way that matches your preferences.`, details: 'We do not use cookies or technology of this type', }, { id: EventCategory.Statistics, title: 'Statistics', description: `We use statistics cookies and similar technologies to collect aggregated, anonymous data that help us understand traffic patterns, popular pages, and overall performance. This information supports continuous improvements to our website.`, provider: 'Human Reference Atlas', providerLink: 'https://humanatlas.io/privacy-policy', }, { id: EventCategory.Marketing, title: 'Marketing', description: `These cookies are used by third-party services, such as YouTube, to enable embedded video playback. If these cookies are disabled, embedded videos will not play on this site.`, provider: 'YouTube', providerLink: 'https://policies.google.com/privacy', }, ]

Definitions for each category

/home/workflows/workspace/libs/design-system/code-block/src/lib/code-block.definition.ts

CodeBlockDef
Type : ContentTemplateDef<CodeBlockComponent>
Default value : { component: CodeBlockComponent, spec: CodeBlockSchema, }

Content template definition for MarkdownComponent

/home/workflows/workspace/libs/design-system/code-block/src/lib/code-block.schema.ts

CodeBlockSchema
Type : unknown
Default value : ContentTemplateSchema.extend({ component: z.literal('CodeBlock'), code: z.string().optional(), language: z.string().optional(), })

Schema for Code Block component

/home/workflows/workspace/libs/design-system/workflow-card/src/index.ts

COMPONENTS
Type : []
Default value : [WorkflowCardComponent, WorkflowCardActionsComponent, WorkflowCardExtraComponent]

All components

/home/workflows/workspace/libs/design-system/privacy/consent-banner/src/lib/consent-banner.component.ts

CONSENT_BANNER_ARIA_LABELLEDBY_ID
Type : string
Default value : 'consentBannerDialogTitle'

Aria labelledby id of consent banner component
CONSENT_BANNER_PANEL_CLASS
Type : string
Default value : 'hra-consent-banner-panel'

Dialog panel class

/home/workflows/workspace/libs/design-system/privacy/src/lib/privacy-preferences.service.ts

CONSENT_BANNER_DIALOG_ID
Type : string
Default value : 'consentBannerDialog'

ID for the consent banner dialog
PRIVACY_PREFERENCES_DIALOG_ID
Type : string
Default value : 'privacyPreferencesDialog'

ID for the privacy preferences dialog
PRIVACY_PREFERENCES_STORAGE_KEY
Type : string
Default value : '__hra-analytics-privacy-preferences'

Key used to store privacy preferences in local storage

/home/workflows/workspace/libs/design-system/cards/content-button/src/lib/content-button.schema.ts

ContentButtonSchema
Type : unknown
Default value : ContentTemplateSchema.extend({ component: z.literal('ContentButton'), image: z.string(), date: z.string(), tagline: z.string(), tags: z.array(z.string()).optional(), link: z.string(), external: z.boolean().optional(), })

Schema for content button action card data

/home/workflows/workspace/libs/design-system/content-templates/content-page/src/lib/types/content-page.schema.ts

ContentPageDataSchema
Type : unknown
Default value : z.object({ $schema: z.string(), title: z.string(), subtitle: z.string(), icons: IconListSchema.optional(), action: z .object({ label: z.string(), url: z.string(), }) .optional(), headerContent: ProjectedContentTemplateSchema.optional(), content: ProjectedContentTemplateSchema, })

Schema for content page data

/home/workflows/workspace/libs/design-system/data-viewer/src/lib/types/data-viewer.definition.ts

DataViewerDef
Type : ContentTemplateDef<DataViewerComponent>
Default value : { component: DataViewerComponent, spec: DataViewerSchema, }

Content template definition for DataViewerComponent

/home/workflows/workspace/libs/design-system/data-viewer/src/lib/types/data-viewer.schema.ts

DataViewerSchema
Type : unknown
Default value : ContentTemplateSchema.extend({ component: z.literal('DataViewer'), variant: DataViewerVariantSchema, githubIconsUrl: z.string(), releaseVersionData: ReleaseVersionDataSchema.array(), })

Schema for data viewer component
DataViewerVariantSchema
Type : unknown
Default value : z.enum(['ftu', '3d-organ'])

Schema for data viewer variant
ReleaseVersionDataSchema
Type : unknown
Default value : z.object({ version: z.string(), label: z.string(), date: z.string(), crosswalkUrl: z.string().url().optional(), extractionsSitesUrl: z.string().url().optional(), referenceOrgansUrl: z.string().url().optional(), organData: ViewerOrganDataSchema.array(), })

Schema for release version data
ViewerCardSchema
Type : unknown
Default value : z.object({ label: z.string(), alt: z.string().optional(), fileUrl: z.string().url(), sourceDataUrl: z.string().url(), fullscreenUrl: z.string().url().optional(), crosswalkUrl: z.string().url().optional(), files: ViewerFileSchema.array(), })

Schema for viewer card data
ViewerFileSchema
Type : unknown
Default value : z.object({ label: z.string(), url: z.string().url(), })

Schema for viewer file data
ViewerOrganDataSchema
Type : unknown
Default value : z.object({ label: z.string(), icon: z.string(), // This is a mat-icon svg icon cards: ViewerCardSchema.array(), })

Schema for organ data

/home/workflows/workspace/libs/design-system/brand/logo/src/lib/default-logos.ts

DEFAULT_LOGOS
Type : BrandLogo[]
Default value : [ { size: 'regular', src: 'assets/brand/logo/regular.svg', width: 178, height: 74, }, { size: 'small', src: 'assets/brand/logo/small.svg', width: 116, height: 48, }, ]

Default logos for applications

/home/workflows/workspace/libs/design-system/scrolling/src/lib/scrolling.module.ts

DEFAULT_POLYFILL_URL
Type : string
Default value : 'assets/polyfills/scroll-timeline-polyfill.js'

Default scroll timeline polyfill url

/home/workflows/workspace/libs/design-system/content-templates/page-section/src/lib/services/page-section-activation.service.ts

DEFAULT_ROOT_MARGIN
Type : string
Default value : '0px 0px -80% 0px'

Default root margin
PAGE_SECTION_ACTIVATION_OPTIONS
Type : unknown
Default value : new InjectionToken<PageSectionActivationOptions>( 'Page Section Activation Options', )

Token used to provide service options

/home/workflows/workspace/libs/design-system/density/src/lib/density.directive.ts

Densities
Type : unknown
Default value : { Compact0: 'compact-0', Compact2: 'compact-2', Compact4: 'compact-4', } as const

Density level enum

/home/workflows/workspace/libs/design-system/navigation/header/src/lib/header.component.ts

DESKTOP_MENU_POSITIONS
Type : ConnectedPosition[]
Default value : [ { originX: 'start', originY: 'bottom', overlayX: 'start', overlayY: 'top', offsetX: -16, offsetY: 16 }, ]

Position of the desktop menu overlay
MOBILE_MENU_POSITIONS
Type : ConnectedPosition[]
Default value : [ { originX: 'start', originY: 'bottom', overlayX: 'start', overlayY: 'top' }, ]

Position of the mobile menu overlay

/home/workflows/workspace/libs/design-system/navigation/site-navigation/src/lib/static-data/parsed.ts

DOCS_NAVIGATION_MENU
Type : unknown
Default value : menuItems as DocsMenuItems

Docs Navigation Menu

/home/workflows/workspace/libs/design-system/navigation/site-navigation/src/lib/types/docs-navigation.schema.ts

DocsMenuItemsSchema
Type : unknown
Default value : z.array(z.union([DocsNavigationCategorySchema, DocsNavigationItemSchema]))

Docs Menu Items Array Schema
DocsNavigationCategorySchema
Type : unknown
Default value : z.object({ type: z.literal('category').optional(), label: z.string(), icon: z.string(), children: z.array(DocsNavigationItemSchema), })

Docs Navigation Category Schema
DocsNavigationItemSchema
Type : unknown
Default value : z.object({ type: z.literal('item'), label: z.string(), icon: z.string().optional(), url: z.string(), })

Docs Navigation Item Schema
DocsNavigationMenuSchema
Type : unknown
Default value : z.object({ $schema: z.string(), menuItems: DocsMenuItemsSchema, })

Docs Navigation Menu Schema

/home/workflows/workspace/libs/design-system/content-templates/flex-container/src/lib/types/flex-container.definition.ts

FlexContainerDef
Type : AnyContentTemplateDef
Default value : { component: FlexContainerComponent, spec: FlexContainerSchema, projectedProperties: { '*': 'content', }, }

FlexContainer content template definition

/home/workflows/workspace/libs/design-system/content-templates/flex-container/src/lib/types/flex-container.schema.ts

FlexContainerSchema
Type : unknown
Default value : ContentTemplateSchema.extend({ component: z.literal('FlexContainer'), rowGap: z.string().optional(), columnGap: z.string().optional(), content: AnyContentTemplateSchema.array(), })

Schema structure of a flex container

/home/workflows/workspace/libs/design-system/icons/src/lib/utils/tokens.ts

FONT_ICONS_CLASSES
Type : unknown
Default value : new InjectionToken('FONT_ICONS_CLASSES', { providedIn: 'root', factory: () => ['material-symbols-rounded'], })

Token with the default font icon classes
SVG_ICON_DIRECTORY
Type : unknown
Default value : new InjectionToken('SVG_ICON_DIRECTORY', { providedIn: 'root', factory: () => 'assets/icons/', })

Token with the svg icon directory

/home/workflows/workspace/libs/design-system/tree/src/lib/tree-size/tree-size.directive.ts

FONT_SIZES
Type : Record<TreeSize, number>
Default value : { small: 0.75, medium: 0.875, large: 1, }

Font sizes for each tree size (rem)
ICON_SIZES
Type : Record<TreeSize, number>
Default value : { small: 1.25, medium: 1.5, large: 1.5, }

Icon sizes for each tree size (rem)
NODE_HEIGHTS
Type : Record<TreeSize, number>
Default value : { small: 1.5, medium: 1.75, large: 2, }

Node heights for each tree size (rem)

/home/workflows/workspace/libs/design-system/navigation/footer/src/lib/static-data/parsed.ts

FUNDER_IDS
Type : unknown
Default value : FUNDERS.map(({ id }) => id)

All available funder ids
FUNDERS
Type : unknown
Default value : FundersSchema.parse(RAW_FUNDERS).funders

Parsed funders static data

/home/workflows/workspace/libs/design-system/navigation/footer/src/lib/types/funders.schema.ts

FunderSchema
Type : unknown
Default value : z.object({ id: z.string().brand<'FunderId'>(), name: z.string(), link: z.string().url(), image: z.string(), })

Schema for a funder item
FundersSchema
Type : unknown
Default value : z.object({ $schema: z.string(), funders: FunderSchema.array(), })

Schema for multiple funders

/home/workflows/workspace/libs/design-system/content-templates/google-maps/src/lib/google-maps.definition.ts

GoogleMapsDef
Type : ContentTemplateDef<GoogleMapsComponent>
Default value : { component: GoogleMapsComponent, spec: GoogleMapsSchema, }

Content template definition for GoogleMapsComponent

/home/workflows/workspace/libs/design-system/content-templates/google-maps/src/lib/google-maps.schema.ts

GoogleMapsSchema
Type : unknown
Default value : ContentTemplateSchema.extend({ component: z.literal('GoogleMaps'), url: z.string(), externalUrl: z.string(), fallbackImageUrl: z.string(), })

Schema for Google Maps component

/home/workflows/workspace/libs/design-system/scrolling/src/lib/scroll-overflow-fade/scroll-overflow-fade.directive.ts

GRADIENT_BOTTOM_KEYFRAMES
Type : Keyframe[]
Default value : [ { top: 'var(--_hra-scroll-overflow-fade-gradient-bottom-start)', }, { offset: 0.98, opacity: 1, }, { top: 'var(--_hra-scroll-overflow-fade-gradient-bottom-end)', opacity: 0, }, ]

Keyframes for the bottom gradient
GRADIENT_TOP_KEYFRAMES
Type : Keyframe[]
Default value : [ { top: 'var(--_hra-scroll-overflow-fade-gradient-top-start)', opacity: 0, }, { offset: 0.02, opacity: 1, }, { top: 'var(--_hra-scroll-overflow-fade-gradient-top-end)', }, ]

Keyframes for the top gradient

/home/workflows/workspace/libs/design-system/content-templates/grid-container/src/lib/types/grid-container.definition.ts

GridContainerDef
Type : AnyContentTemplateDef
Default value : { component: GridContainerComponent, spec: GridContainerSchema, projectedProperties: { '*': 'content', }, }

GridContainer content template definition

/home/workflows/workspace/libs/design-system/content-templates/grid-container/src/lib/types/grid-container.schema.ts

GridContainerSchema
Type : unknown
Default value : ContentTemplateSchema.extend({ component: z.literal('GridContainer'), itemMinWidth: z.string().optional(), content: AnyContentTemplateSchema.array(), })

Schema structure of a grid container

/home/workflows/workspace/libs/design-system/navigation/header/src/lib/static-data/parsed.ts

HUBMAP_MENU
Type : unknown
Default value : groups as HubmapMenuGroup[]

Hubmap menu objects
MENUS
Type : unknown
Default value : menus as Menu[]

Menus objects

/home/workflows/workspace/libs/design-system/navigation/header/src/lib/types/hubmap-menu.schema.ts

HubmapMenuGroupSchema
Type : unknown
Default value : z.object({ label: z.string(), items: HubmapMenuItemSchema.array(), })

Schema for a hubmap menu group
HubmapMenuItemSchema
Type : unknown
Default value : z.object({ label: z.string(), description: z.string(), icon: z.string(), url: z.string().url(), })

Schema for a hubmap menu item
HubmapMenuSchema
Type : unknown
Default value : z.object({ $schema: z.string(), groups: HubmapMenuGroupSchema.array(), })

Schema for a humbap menu

/home/workflows/workspace/libs/design-system/table/src/lib/types/page-table.schema.ts

IconColumnTypeSchema
Type : unknown
Default value : z.object({ type: z.literal('icon'), icon: z.string(), tooltip: z.string().optional(), })

Schema for Icon Column
LinkColumnTypeSchema
Type : unknown
Default value : z.object({ type: z.literal('link'), urlColumn: z.string(), internal: z.boolean().optional(), })

Schema for Link Column
MarkdownColumnTypeSchema
Type : unknown
Default value : z.object({ type: z.literal('markdown'), })

Schema for Markdown Column
MenuButtonColumnTypeSchema
Type : unknown
Default value : z.object({ type: z.literal('menu'), icon: z.string(), options: z.string(), tooltip: z.string().optional(), })

Schema for MenuButton Column
MenuOptionsTypeSchema
Type : unknown
Default value : z.object({ id: z.string(), name: z.string(), icon: z.string(), description: z.string().optional(), url: z.string().url().optional(), })

Schema for MenuOptions Column
NumericColumnTypeSchema
Type : unknown
Default value : z.object({ type: z.literal('numeric'), computeTotal: z.boolean().optional(), // TODO add format })

Schema for Numeric Column
PageTableSchema
Type : unknown
Default value : ContentTemplateSchema.extend({ component: z.literal('PageTable'), csvUrl: z.string().optional(), columns: TableColumnSchema.array().optional(), rows: z.array(TableRowSchema).optional(), style: TableVariantSchema.optional(), enableSort: z.boolean().optional(), verticalDividers: z.boolean().optional(), enableSelection: z.boolean().optional(), })

Schema for page table component
SimpleTableColumnTypeSchema
Type : unknown
Default value : z.union([ TextColumnTypeSchema.shape.type, NumericColumnTypeSchema.shape.type, MarkdownColumnTypeSchema.shape.type, IconColumnTypeSchema.shape.type, MenuButtonColumnTypeSchema.shape.type, ])

Union of Schema Types for Simple Columns
TableColumnSchema
Type : unknown
Default value : z.object({ column: z.string(), label: z.string(), type: z.union([SimpleTableColumnTypeSchema, TableColumnTypeSchema]).default('text'), })

Schema for table columns
TableColumnTypeSchema
Type : unknown
Default value : z.union([ TextColumnTypeSchema, NumericColumnTypeSchema, MarkdownColumnTypeSchema, LinkColumnTypeSchema, IconColumnTypeSchema, MenuButtonColumnTypeSchema, ])

Union of Schema Types for Table Columns
TableRowSchema
Type : unknown
Default value : z.record(z.string(), z.union([z.string(), z.number(), z.boolean(), z.array(z.any())]))

Schema for a single table row
TableVariantSchema
Type : unknown
Default value : z.enum(['alternating', 'divider', 'basic'])

Schema for table style
TextColumnTypeSchema
Type : unknown
Default value : z.object({ type: z.literal('text'), })

Schema for Text Column

/home/workflows/workspace/libs/design-system/icons/src/lib/types/icon.schema.ts

IconDataSchema
Type : unknown
Default value : z.object({ svgIcon: z.string().optional(), fontIcon: z.string().optional(), fontSet: z.string().optional(), inline: z.boolean().optional(), })

Schema for icon data
IconListSchema
Type : unknown
Default value : z.union([ z.union([z.string(), IconDataSchema]), z.union([z.string(), IconDataSchema]).array(), ])

Schema for icon list
IconSchema
Type : unknown
Default value : ContentTemplateSchema.extend({ component: z.literal('Icon'), }).merge(IconDataSchema)

Schema for icon content template

/home/workflows/workspace/libs/design-system/icons/src/lib/types/icon.definition.ts

IconDef
Type : ContentTemplateDef<IconComponent>
Default value : { component: IconComponent, spec: IconSchema, }

Icon content template definition

/home/workflows/workspace/libs/design-system/expansion-panel/src/lib/expansion-panel.component.ts

idCounter
Type : number
Default value : 0

Counter to keep track of distinct panels

/home/workflows/workspace/libs/design-system/content-templates/image/src/lib/types/image.definition.ts

ImageDef
Type : ContentTemplateDef<ImageComponent>
Default value : { component: ImageComponent, spec: ImageSchema, }

Content template definition for ImageComponent

/home/workflows/workspace/libs/design-system/content-templates/image/src/lib/types/image.schema.ts

ImageSchema
Type : unknown
Default value : ContentTemplateSchema.extend({ component: z.literal('Image'), src: z.string(), alt: z.string().optional(), })

Schema for image component

/home/workflows/workspace/libs/design-system/content-templates/markdown/src/lib/markdown.definition.ts

MarkdownDef
Type : ContentTemplateDef<MarkdownComponent>
Default value : { component: MarkdownComponent, spec: MarkdownSchema, }

Content template definition for MarkdownComponent

/home/workflows/workspace/libs/design-system/content-templates/markdown/src/lib/markdown.schema.ts

MarkdownSchema
Type : unknown
Default value : ContentTemplateSchema.extend({ component: z.literal('Markdown'), data: z.string().optional(), src: z.string().optional(), })

Schema for markdown component

/home/workflows/workspace/libs/design-system/brand/mark/src/lib/static-data/parsed.ts

MARKS
Type : unknown
Default value : BrandMarksSchema.parse(RAW_MARKS).marks

All marks data

/home/workflows/workspace/libs/design-system/navigation/header/src/lib/types/menus.schema.ts

MenuDividerSchema
Type : unknown
Default value : z.object({ type: z.literal('divider'), })

Schema for a menu divider
MenuGroupSchema
Type : unknown
Default value : z.object({ type: z.literal('group'), label: z.string(), description: z.string().optional(), url: z.string().url(), external: z.boolean().optional(), target: z.string().optional(), items: z.union([MenuSubGroupSchema, MenuItemSchema]).array().optional(), })

Schema for a menu group
MenuItemSchema
Type : unknown
Default value : z.object({ type: z.literal('item'), label: z.string(), url: z.string().url(), external: z.boolean().optional(), target: z.string().optional(), })

Schema for a menu item
MenuSchema
Type : unknown
Default value : z.object({ type: z.literal('menu'), id: z.string(), label: z.string(), items: z.union([MenuGroupSchema, MenuDividerSchema]).array(), })

Schema for a menu
MenusSchema
Type : unknown
Default value : z.object({ $schema: z.string(), menus: MenuSchema.array(), })

Schema for multiple menus
MenuSubGroupSchema
Type : unknown
Default value : z.object({ type: z.literal('subgroup'), label: z.string(), items: MenuItemSchema.array(), })

Schema for a menu subgroup

/home/workflows/workspace/libs/design-system/brand/miscellaneous-logo/src/lib/providers.ts

MISCELLANEOUS_ICON_CONFIG
Type : IconConfig
Default value : { color: '#ffffff', backgroundColor: '#4b4b5e', }

Icon configuration for miscellaneous logos

/home/workflows/workspace/libs/design-system/brand/organ-logo/src/lib/providers.ts

ORGAN_ICON_CONFIG
Type : IconConfig
Default value : { color: '#ffffff', backgroundColor: '#ff0043', }

Icon configuration for organ logos

/home/workflows/workspace/libs/design-system/tree/src/lib/tree-demo/tree-demo.component.ts

PADDING
Type : Record<TreeSize, number>
Default value : { small: 32, medium: 36, large: 40, }

Padding indents for each tree size (px)

/home/workflows/workspace/libs/design-system/content-templates/page-section/src/lib/types/page-section.definition.ts

PageSectionDef
Type : AnyContentTemplateDef
Default value : { component: PageSectionComponent, spec: PageSectionSchema, projectedProperties: { '*': 'content', }, }

PageSection content template definition

/home/workflows/workspace/libs/design-system/content-templates/page-section/src/lib/types/page-section.schema.ts

PageSectionSchema
Type : unknown
Default value : ContentTemplateSchema.extend({ component: z.literal('PageSection'), tagline: z.string(), level: z.number().int().gte(1).lte(6).optional(), icons: IconListSchema.optional(), anchor: z.string().optional(), content: ProjectedContentTemplateSchema, })

Schema structure of a Page Section

/home/workflows/workspace/libs/design-system/table/src/lib/types/page-table.definition.ts

PageTableDef
Type : ContentTemplateDef<TableComponent>
Default value : { component: TableComponent, spec: PageTableSchema, }

Content template definition for TableComponent

/home/workflows/workspace/libs/design-system/tooltips/rich-tooltip/src/lib/rich-tooltip.directive.ts

POSITIONS
Type : ConnectedPosition[]
Default value : [ { originX: 'center', originY: 'bottom', overlayX: 'center', overlayY: 'top', }, { originX: 'end', originY: 'bottom', overlayX: 'start', overlayY: 'top', }, { originX: 'start', originY: 'bottom', overlayX: 'end', overlayY: 'top', }, { originX: 'center', originY: 'top', overlayX: 'center', overlayY: 'bottom', }, { originX: 'end', originY: 'top', overlayX: 'start', overlayY: 'bottom', }, { originX: 'start', originY: 'top', overlayX: 'end', overlayY: 'bottom', }, ]

Default positions array
VIEWPORT_MARGIN
Type : number
Default value : 8

Viewport margin for the rich tooltip

/home/workflows/workspace/libs/design-system/brand/product-logo/src/lib/providers.ts

PRODUCT_ICON_CONFIG
Type : IconConfig
Default value : { color: '#ffffff', backgroundColor: '#201e3d', }

Icon configuration for product logos

/home/workflows/workspace/libs/design-system/cards/profile-card/src/lib/types/profile-card.definition.ts

ProfileCardDef
Type : ContentTemplateDef<ProfileCardComponent>
Default value : { component: ProfileCardComponent, spec: ProfileCardSchema, projectedProperties: { '*': 'actions', }, }

ProfileCard content template definition

/home/workflows/workspace/libs/design-system/cards/profile-card/src/lib/types/profile-card.schema.ts

ProfileCardSchema
Type : unknown
Default value : ContentTemplateSchema.extend({ component: z.literal('ProfileCard'), name: z.string(), description: z.string(), pictureUrl: z.string(), centerContent: z.boolean().optional(), actions: ProjectedContentTemplateSchema.optional(), })

Profile card schema

/home/workflows/workspace/libs/design-system/buttons/src/lib/buttons.module.ts

REEXPORTS
Type : []
Default value : [ MatButtonModule, MatButtonToggleModule, MatChipsModule, IconButtonModule, InfoButtonComponent, InfoButtonTaglineDirective, InfoButtonActionsDirective, AppNavButtonComponent, BreadcrumbsComponent, ButtonSizeDirective, ButtonToggleSizeDirective, ButtonVariantDirective, CheckboxErrorVariantDirective, CtaButtonDirective, HelpButtonComponent, NavigationButtonComponent, NavigationButtonTaglineDirective, NavigationButtonDescriptionDirective, NavigationIconDirective, NavigationCategoryToggleComponent, PrimaryButtonVariantDirective, SecondaryButtonVariantDirective, SocialMediaButtonComponent, TextButtonDirective, TextHyperlinkComponent, TextHyperlinkDirective, ]

All re-exported modules, components, directives, etc.

/home/workflows/workspace/libs/design-system/navigation/src/lib/navigation.module.ts

REEXPORTS
Type : []
Default value : [BackButtonBarComponent, CtaBarComponent, FooterComponent, HeaderComponent, SiteNavigationComponent]

All sub library components, module, etc.

/home/workflows/workspace/libs/design-system/cards/flat-card/src/lib/flat-card.module.ts

REEXPORTS
Type : []
Default value : [FlatCardComponent, FlatCardActionsComponent]

All re-exported modules, components, directives, etc.

/home/workflows/workspace/libs/design-system/scrolling/src/lib/scroll-timeline/scroll-timeline.ts

SCROLL_TIMELINE
Type : unknown
Default value : new InjectionToken<Signal<ScrollTimelineFunc | null>>('SCROLL_TIMELINE', { providedIn: 'root', factory: () => { type WindowWithScrollTimeline = { ScrollTimeline: ScrollTimelineFunc }; const window = inject(DOCUMENT).defaultView as unknown as WindowWithScrollTimeline | null; if (!isPlatformBrowser(inject(PLATFORM_ID)) || !window) { return signal(null); } const isAvailable = () => 'ScrollTimeline' in window && typeof window.ScrollTimeline === 'function'; if (isAvailable()) { return signal(window['ScrollTimeline']); } const scrollTimeline$ = inject(SCROLL_TIMELINE_QUERY_INTERVAL).pipe( takeWhile(() => !isAvailable()), ignoreElements(), endWith(null), map(() => window.ScrollTimeline), ); return toSignal(scrollTimeline$, { initialValue: null }); }, })

Provides ScrollTimeline as a signal. If not natively implemented it will try to wait for a polyfill to provide the function.
SCROLL_TIMELINE_QUERY_INTERVAL
Type : unknown
Default value : new InjectionToken<Observable<number>>('SCROLL_TIMELINE_QUERY_INTERVAL', { providedIn: 'root', factory: () => interval(100), })

Interval between scroll timeline availability checks. Primarily used to simplify testing.

/home/workflows/workspace/libs/design-system/buttons/social-media-button/src/lib/static-data/parsed.ts

SOCIAL_IDS
Type : unknown
Default value : SOCIALS.map(({ id }) => id)

All available social ids
SOCIALS
Type : unknown
Default value : SocialsSchema.parse(RAW_SOCIALS).socials

Parsed social media items

/home/workflows/workspace/libs/design-system/buttons/social-media-button/src/lib/types/social-media.schema.ts

SocialMediaSchema
Type : unknown
Default value : z.object({ id: z.string().brand<'SocialMediaId'>(), label: z.string(), icon: z.string(), isFontIcon: z.boolean().optional(), link: z.string(), })

Schema for social media item
SocialsSchema
Type : unknown
Default value : z.object({ $schema: z.string(), socials: SocialMediaSchema.array(), })

Schema for social media items

/home/workflows/workspace/libs/design-system/indicators/software-status-indicator/src/lib/software-status-indicator-size.directive.ts

STATUS_FONTS
Type : Record<SoftwareStatusSize, string>
Default value : { small: 'var(--mat-sys-label-micro)', medium: 'var(--mat-sys-label-medium)', large: 'var(--mat-sys-label-large)', }

Record of button fonts

/home/workflows/workspace/libs/design-system/privacy/privacy-preferences/src/lib/privacy-preferences.component.ts

tabIdToIndex
Type : Record<PrivacyPreferencesTab, number>
Default value : { consent: 0, manage: 1, }

Mapping of tab IDs to their respective index

/home/workflows/workspace/libs/design-system/buttons/text-hyperlink/src/lib/types/text-hyperlink.definition.ts

TextHyperlinkDef
Type : ContentTemplateDef<TextHyperlinkComponent>
Default value : { component: TextHyperlinkComponent, spec: TextHyperlinkSchema, }

Text hyperlink component definition

/home/workflows/workspace/libs/design-system/buttons/text-hyperlink/src/lib/types/text-hyperlink.schema.ts

TextHyperlinkSchema
Type : unknown
Default value : ContentTemplateSchema.extend({ component: z.literal('TextHyperlink'), text: z.string(), url: z.string(), icon: z.string().optional(), })

Text hyperlink component schema

/home/workflows/workspace/libs/design-system/content-templates/versioned-data-table/src/lib/types/versioned-data-table.schema.ts

VersionedDataSchema
Type : unknown
Default value : PageTableSchema.pick({ csvUrl: true, columns: true, rows: true, style: true, enableSort: true, verticalDividers: true, }).extend({ label: z.string(), version: z.string(), })

Schema for versioned data
VersionedDataTableSchema
Type : unknown
Default value : ContentTemplateSchema.merge( PageTableSchema.pick({ columns: true, style: true, enableSort: true, verticalDividers: true, }), ).extend({ component: z.literal('VersionedDataTable'), label: z.string(), selection: z.number().optional(), items: VersionedDataSchema.array(), })

Schema for versioned data table

This schema extends the PageTableSchema and adds additional properties specific to the versioned table data component.

/home/workflows/workspace/libs/design-system/content-templates/versioned-data-table/src/lib/types/versioned-data-table.definition.ts

VersionedDataTableDef
Type : ContentTemplateDef<VersionedDataTableComponent>
Default value : { component: VersionedDataTableComponent, spec: VersionedDataTableSchema, }

Content template definition for VersionedTableDataComponent

/home/workflows/workspace/libs/design-system/content-templates/youtube-player/src/lib/types/youtube-player.definition.ts

YouTubePlayerDef
Type : ContentTemplateDef<HraYoutubePlayerComponent>
Default value : { component: HraYoutubePlayerComponent, spec: YouTubePlayerSchema, }

Content template definition for YoutubePlayer

/home/workflows/workspace/libs/design-system/content-templates/youtube-player/src/lib/types/youtube-player.schema.ts

YouTubePlayerSchema
Type : unknown
Default value : ContentTemplateSchema.extend({ component: z.literal('YouTubePlayer'), videoId: z.string(), label: z.string(), })

Schema for YouTube component

results matching ""

    No results matching ""