Code Documentation for design-system
  1. Miscellaneous
  2. Functions

Index

icons/src/lib/utils/coercion.ts

coerceIconList
coerceIconList(list: IconList)

Coerces mixed format icons into a list of icon object that can be passed directly into hra-icon's [icon] input or into a hraContentTemplateOutlet

Parameters :
Name Type Optional Default value Description
list IconList No []

Mixed format icon list
Returns : Icon[]

A list of icon objects

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

colorEquals
colorEquals(color1: Rgb, color2: Rgb)

Compares two RGB colors for equality

Parameters :
Name Type Optional
color1 Rgb No
color2 Rgb No
Returns : boolean
hexToRgb
hexToRgb(hex: string)

Converts a hexadecimal color string to an RGB color

Parameters :
Name Type Optional
hex string No
Returns : Rgb
rgbToHex
rgbToHex(rgb: Rgb)

Converts an RGB color to its hexadecimal string representation

Parameters :
Name Type Optional
rgb Rgb No
Returns : string

content-templates/resolvers/src/lib/spec.resolver.ts

createJsonSpecResolver
createJsonSpecResolver(url: string, spec: T)

Creates a resolver function that loads and validates json data

Parameters :
Name Type Optional Description
url string No

Json url path
spec T No

Zod schema to validate the spec
Returns : ResolveFn<z.infer<T>>

A resolver function
createYamlSpecResolver
createYamlSpecResolver(url: string, spec: T)

Creates a resolver function that loads and validates yaml data

Parameters :
Name Type Optional Description
url string No
spec T No

Zod schema to validate the spec
Returns : ResolveFn<z.infer<T>>

A resolver function

brand/miscellaneous-logo/src/lib/providers.ts

createMiscellaneousLogoConfigResolver
createMiscellaneousLogoConfigResolver()

Creates a new configuration resolver

Returns : IconConfigResolver

A configuration resolver
provideMiscellaneousLogos
provideMiscellaneousLogos()

Initializes miscellaneous logo icons

Returns : EnvironmentProviders

brand/organ-logo/src/lib/providers.ts

createOrganLogoConfigResolver
createOrganLogoConfigResolver()

Creates a new configuration resolver

Returns : IconConfigResolver

A configuration resolver
provideOrganLogos
provideOrganLogos()

Initializes organ logo icons

Returns : EnvironmentProviders

brand/product-logo/src/lib/providers.ts

createProductLogoConfigResolver
createProductLogoConfigResolver()

Creates a new configuration resolver

Returns : IconConfigResolver

A configuration resolver
provideProductLogos
provideProductLogos()

Initializes product logo icons

Returns : EnvironmentProviders

icons/src/lib/resolvers/icon.resolver.ts

createSvgIconResolver
createSvgIconResolver()

Creates a new resolver that resolves svg icons by concatenating the svg icon directory with the icon namespace and name.

Returns : IconResolver

An icon resolver

content-templates/page-section/src/lib/services/page-section.service.ts

getSectionElement
getSectionElement(section: PageSectionInstance)

Helper for getting a page section's html element

Parameters :
Name Type Optional Description
section PageSectionInstance No

A page section
Returns : Element

The section element

icons/src/lib/utils/initialize.ts

initializeIcons
initializeIcons()

Initializes design system icons by configuring material's icon registry

Returns : void

icons/src/lib/providers.ts

makeIconFeature
makeIconFeature(kind: KindT, providers)

Helper for creating icon feature objects

Parameters :
Name Type Optional Description
kind KindT No

Feature kind
providers No

Array of providers for the feature
Returns : IconFeature<KindT>

A new feature object
provideIcons
provideIcons(...features: undefined)

Setups design system icons

Parameters :
Name Optional Description
features No

Additional icon features
Returns : EnvironmentProviders
withFontIconClasses
withFontIconClasses(classes)

Set the default font icon classes

Parameters :
Name Optional Description
classes No

Default font icon classes
Returns : FontIconClassesFeature
withSvgIconDirectory
withSvgIconDirectory(directory: string)

Set the svg icon directory

Parameters :
Name Type Optional Description
directory string No

Icon directory
Returns : SvgIconDirectoryFeature

brand/src/lib/providers.ts

provideBrand
provideBrand()

Provide brand components

Returns : EnvironmentProviders

buttons/src/lib/providers.ts

provideButtons
provideButtons()

Collects all subpackage providers into a single provider function.

Returns : EnvironmentProviders

Button providers

buttons/button-toggle/src/lib/providers.ts

provideButtonToggle
provideButtonToggle()

Applies global styles to button toggles

Returns : EnvironmentProviders

Button toggle providers

code-block/src/lib/providers.ts

provideCodeBlock
provideCodeBlock()

Provide the code block component and its dependencies to highlight code.

Returns : EnvironmentProviders

src/lib/providers.ts

provideDesignSystem
provideDesignSystem(options?: DesignSystemOptions)

Returns design system providers

Parameters :
Name Type Optional
options DesignSystemOptions Yes
Returns : EnvironmentProviders
provideDesignSystemCommon
provideDesignSystemCommon(options?: DesignSystemOptions)

Get the providers shared between prod and testing

Parameters :
Name Type Optional
options DesignSystemOptions Yes

content-templates/page-section/src/lib/providers.ts

providePageSectionNavigation
providePageSectionNavigation(options: PageSectionActivationOptions)

Provides the services required for page section tracking. Should be provided inside a component - not in root!

Parameters :
Name Type Optional Default value Description
options PageSectionActivationOptions No {}

Page section activation options
Returns : Provider[]

Component providers

scrolling/src/lib/scrolling.module.ts

provideScrolling
provideScrolling(options?: ScrollingOptions)

Provide scrolling functionality to an application.

Parameters :
Name Type Optional Description
options ScrollingOptions Yes

Scrollbar options
Returns : EnvironmentProviders

An environment provider

tabs/src/lib/tabs/providers.ts

provideTabs
provideTabs()

Applies global configuration for material UI tabs.

Returns : EnvironmentProviders

Providers with global configuration.

buttons/text-hyperlink/src/lib/providers.ts

provideTextHyperlink
provideTextHyperlink()

Provides the global styles for text hyperlink elements.

Returns : EnvironmentProviders

Text hyperlink providers

tree/src/lib/providers.ts

provideTrees
provideTrees()

Returns providers for tree

Returns : EnvironmentProviders

navigation/site-navigation/src/lib/utils/resolve-url.ts

resolveUrl
resolveUrl(url: string, router?: Router, rawBaseUrl: string)

Resolves an url against the baseUrl

Parameters :
Name Type Optional Default value Description
url string No

Raw url
router Router Yes

Router service
rawBaseUrl string No ''

Base url
Returns : literal type

Whether the url is absolute along with the resolved url

scrolling/testing/src/index.ts

setupScrollTesting
setupScrollTesting()

Setup the testing environment for scrolling to work. Adds global mocks for functions used by scrolling if they don't exist.

Returns : void

results matching ""

    No results matching ""