Code Documentation for design-system
  1. Miscellaneous
  2. Type aliases

Index

cards/action-card/src/lib/action-card.schema.ts

ActionCard

Content template action card data
z.infer<unknown>
ActionCardVariant

Action card variants
z.infer<unknown>

content-templates/api-command/src/lib/api-command.schema.ts

ApiCommand

API command type
z.infer<unknown>
ApiCommandButton

API command button type
z.infer<unknown>

brand/logo/src/lib/brand-logos.ts

BrandLogoSize

Brand logo size
"regular" | "small"

brand/mark/src/lib/brand-marks.ts

BrandMarkVariant

Brand mark variant
"default" | "contrast" | "small"

buttons/button/src/lib/types/button.schema.ts

Button

HRA button type
z.infer<unknown>

snackbar/src/lib/snackbar.component.ts

ButtonPosition

Type for button position
"start" | "end"

buttons/button/src/lib/directives/size.directive.ts

ButtonSize

Named button sizes
"small" | "medium" | "large"

buttons/button-toggle/src/lib/directives/button-toggle-size.directive.ts

ButtonToggleSize

Button toggle size
"small" | "medium" | "large"

buttons/button/src/lib/directives/variant.directive.ts

ButtonVariant

Named button variants
"primary" | "secondary"

chips/src/lib/chip-size.directive.ts

ChipSize

Named chip sizes
"small" | "medium" | "large"

code-block/src/lib/code-block.schema.ts

CodeBlock

Code Block component data
z.infer<unknown>

privacy/consent-banner/src/lib/consent-banner.component.ts

ConsentBannerResult

Result of the consent banner
"allow-all" | "allow-necessary" | "customize"

cards/content-button/src/lib/content-button.schema.ts

ContentButton

Content button action card type
z.infer<unknown>

content-templates/content-page/src/lib/types/content-page.schema.ts

ContentPageData

Content page type
z.infer<unknown>

data-viewer/src/lib/types/data-viewer.schema.ts

DataViewer

Data viewer component data
z.infer<unknown>
DataViewerVariant

Data viewer variant
z.infer<unknown>
ReleaseVersionData

Type for release version data, includes organ data for all organs
z.infer<unknown>
ViewerCard

Type for viewer card data, includes file data for the card
z.infer<unknown>
ViewerFile

Type for viewer file data, includes label and URL
z.infer<unknown>
ViewerOrganData

Type for individual organ data, includes data for the viewer cards of that organ
z.infer<unknown>

density/src/lib/density.directive.ts

Density

Density levels
ValueOf<unknown>

navigation/site-navigation/src/lib/types/docs-navigation.schema.ts

DocsMenuItems

Docs Menu Items Array Type
z.infer<unknown>
DocsNavigationCategory

Docs Navigation Category
z.infer<unknown>
DocsNavigationItem

Docs Navigation Item
z.infer<unknown>
DocsNavigationMenu

Docs Navigation Menu
z.infer<unknown>

icons/src/lib/providers.ts

FontIconClassesFeature

Font icon classes feature
IconFeature<IconFeatureKind.FontIconClasses>
IconFeatures

All icon features
FontIconClassesFeature | SvgIconDirectoryFeature
SvgIconDirectoryFeature

Svg icon directory feature
IconFeature<IconFeatureKind.SvgIconDirectory>

navigation/footer/src/lib/types/funders.schema.ts

Funder

A funder item
z.infer<unknown>
FunderId

Data id of a funder
Funder
Funders

Multiple funders object
z.infer<unknown>

content-templates/google-maps/src/lib/google-maps.schema.ts

GoogleMaps

Google Maps component data
z.infer<unknown>

navigation/header/src/lib/types/hubmap-menu.schema.ts

HubmapMenu

A hubmap menu
z.infer<unknown>
HubmapMenuGroup

A hubmap menu group
z.infer<unknown>
HubmapMenuItem

A hubmap menu item
z.infer<unknown>

icons/src/lib/types/icon.schema.ts

Icon

Icon content template
z.infer<unknown>
IconData

Icon data
z.infer<unknown>
IconList

One or more mixed icon items
z.infer<unknown>

buttons/icon-button/src/lib/icon-button-size/icon-button-size.directive.ts

IconButtonSize

Input options for icon button size
"small" | "large"

buttons/icon-button/src/lib/icon-button-variant/icon-button-variant.directive.ts

IconButtonVariant

Input options for icon button color
"light" | "dark" | "color"

table/src/lib/types/page-table.schema.ts

IconColumnType

Type for Icon Column
z.infer<unknown>
LinkColumnType

Type for Link Column
z.infer<unknown>
MarkdownColumnType

Type for Markdown Column
z.infer<unknown>
MenuButtonColumnType

Type for MenuButton Column
z.infer<unknown>
MenuOptionsType

Type for MenuOptions Column
z.infer<unknown>
NumericColumnType

Type for Numeric Column
z.infer<unknown>
PageTable

Page table component data
z.infer<unknown>
TableColumn

Type for table columns
z.infer<unknown>
TableColumnType

Inferred types for Table Columns
z.infer<unknown>
TableColumnWithType

Type for the columns with type specified
unknown
TableRow

Type for a single table row
z.infer<unknown>
TableVariant

Type for table style
z.infer<unknown>
TextColumnType

Type for Text Column
z.infer<unknown>

icons/src/lib/services/icon-config.service.ts

IconConfigResolver

An icon configuration resolver callback function. Returning undefined from a resolver instructs the registry to continue calling other resolvers to determine the configuration
function

content-templates/image/src/lib/types/image.schema.ts

Image

Image component data
z.infer<unknown>

content-templates/markdown/src/lib/markdown.schema.ts

Markdown

Markdown component data
z.infer<unknown>

navigation/header/src/lib/types/menus.schema.ts

Menu

A menu
z.infer<unknown>
MenuDivider

A menu divider
z.infer<unknown>
MenuGroup

A menu group
z.infer<unknown>
MenuItem

A menu item
z.infer<unknown>
Menus

Multiple menus
z.infer<unknown>
MenuSubGroup

A menu subgroup
z.infer<unknown>

navigation/header/src/lib/menu-content/menu-content.component.ts

MenuContentVariant

Display modes of the menu content component
"desktop" | "mobile"

nav-header-buttons/src/lib/nav-header-buttons.component.ts

NavHeaderButtonsVariant

Variant of nav header button
"basic" | "sidenav"

buttons/navigation-button/src/lib/navigation-button.component.ts

NavigationButtonVariant

Type for the navigation button variant
"cta" | "basic"

buttons/navigation-button/src/lib/navigation-icon.directive.ts

NavigationIconPosition

Position for navigation icon
"leading" | "trailing"

page-section-bottom-sheet/src/lib/page-section-bottom-sheet.component.ts

PageSectionBottomSheetData

Union type for the Page Section Bottom Sheet Data
SinglePageSectionBottomSheetData | MultiplePageSectionsBottomSheetData

tooltips/plain-tooltip/src/plain-tooltip.directive.ts

PlainTooltipSize

Type of Tooltip size
"small" | "medium"

privacy/privacy-preferences/src/lib/privacy-preferences.component.ts

PrivacyPreferencesResult

Result type returned when the Privacy Preferences Modal is closed
"allow-all" | "allow-necessary" | "dismiss" | ConsentCategories
PrivacyPreferencesTab

Tab identifiers
"consent" | "manage"

cards/profile-card/src/lib/types/profile-card.schema.ts

ProfileCard

Type for profile card
z.infer<unknown>

indicators/progress-bar/src/lib/progress-bar-color.directive.ts

ProgressBarColor

Color options
"dark" | "color"

color-picker/src/lib/color-utils.ts

Rgb

Type representing an RGB color as a tuple of three numbers
[unknown, unknown, unknown]

table/src/lib/table/table.component.ts

RowElementContext

Type for the row element context
literal type

scrolling/src/lib/scroll-timeline/scroll-timeline.ts

ScrollTimelineFunc

Basic signature of the ScrollTimeline constructor
unknown

snackbar/src/lib/snackbar.service.ts

SnackbarConfig

Snackbar configuration
Omit<MatSnackBarConfig | "data" | "panelClass">

buttons/social-media-button/src/lib/types/social-media.schema.ts

SocialMedia

Social media item
z.infer<unknown>
SocialMediaId

Social media id
SocialMedia
Socials

Social media items
z.infer<unknown>

indicators/software-status-indicator/src/lib/software-status-indicator.component.ts

SoftwareStatus

Software status options
"Preview" | "Alpha" | "Beta"
SoftwareStatusSize

Software status size options
"small" | "medium" | "large"

indicators/software-status-indicator/src/lib/software-status-indicator-size.directive.ts

SoftwareStatusSize

Input options for Software status size
"small" | "medium" | "large"

indicators/progress-spinner/src/lib/progress-spinner.component.ts

SpinnerColor

Color options
"dark" | "light" | "color"
SpinnerSize

Alignment options
"small" | "large"

buttons/text-hyperlink/src/lib/types/text-hyperlink.schema.ts

TextHyperlink

Text hyperlink component type
z.infer<unknown>

tree/src/lib/tree-size/tree-size.directive.ts

TreeSize

Input options for each tree size
"small" | "medium" | "large"

content-templates/versioned-data-table/src/lib/types/versioned-data-table.schema.ts

VersionedData

Schema for versioned data
z.infer<unknown>
VersionedDataTable

Type for versioned Data Table
z.infer<unknown>

buttons/visual-button/src/lib/visual-button.component.ts

VisualButtonVariant

Type for the visual button
"bottom" | "top"

content-templates/youtube-player/src/lib/types/youtube-player.schema.ts

YouTubePlayer

YouTube component data
z.infer<unknown>

results matching ""

    No results matching ""