@nationalbankbelgium/stark-ui documentation
  1. Miscellaneous
  2. Functions

Index

src/modules/input-mask-directives/directives/timestamp-pipe.fn.ts

createTimestampPipe
createTimestampPipe(timestampFormat: string)

Creates a PipeFunction to be used with the StarkTimestampMaskDirective to enforce an specific timestamp format.

Parameters :
Name Type Optional Default value Description
timestampFormat string No "DD-MM-YYYY HH:mm:ss"
  • Timestamp format to be enforced by the pipe function to be created
Returns : PipeFunction

src/modules/session-ui/routes.ts

destroyOverlaysOnEnterFn
destroyOverlaysOnEnterFn(transition: Transition)

Hook to destroy the OverlayContainer inside which all overlays are rendered (i.e. stark-dropdown options) Fixes https://github.com/NationalBankBelgium/stark/issues/1570

Parameters :
Name Type Optional Description
transition Transition No
  • Transition object
Returns : HookResult

src/modules/message-pane/reducers/messages-pane.reducer.ts

insertMessage
insertMessage(messageArray, newMessage: StarkMessage)

This function ensures that the new message is inserted in the right order. The messages should be ordered by ascending priority and then ordered by time (the most recent first).

Parameters :
Name Type Optional Description
messageArray No
  • The array of messages to insert the new message to
newMessage StarkMessage No
  • The new message to be inserted in the array
Returns : StarkMessage[]

Array of messages including the inserted message in the right order
messagesReducer
messagesReducer(state, action: Readonly)

Definition of the message reducer.

Parameters :
Name Type Optional Description
state No
  • The state of the reducer
action Readonly No
  • The action to perform
Returns : Readonly<StarkMessageCollection>

src/modules/input-mask-directives/directives/timestamp-mask-config.intf.ts

isStarkTimestampMaskConfig
isStarkTimestampMaskConfig(config: any)

Type guard for {StarkTimestampMaskConfig|StarkTimestampMaskConfig}

Parameters :
Name Type Optional Description
config any No
  • Config to validate
Returns : StarkTimestampMaskConfig

src/common/translations/merge-translations.ts

mergeUiTranslations
mergeUiTranslations(translateService: TranslateService, ...localesToMerge: undefined)

This function can be used by Stark UI modules to merge their translations into existing translations, without losing any existing translations.

See mergeTranslations docs for more information about how the translations are merged.

Parameters :
Name Type Optional Description
translateService TranslateService No
  • The TranslateService instance of the application.
localesToMerge No
  • A list of StarkLocales that contain the translations for a specific language
Returns : void

src/modules/progress-indicator/reducers/progress-indicator.reducer.ts

progressIndicatorReducer
progressIndicatorReducer(state, action)

Reducer for the progress indicator

Parameters :
Name Optional Description
state No
  • Map<string, StarkProgressIndicatorFullConfig> the actual state of the progress indicator
action No
  • StarkProgressIndicatorActions the action to perform
Returns : Map<string, StarkProgressIndicatorFullConfig>

Map<string, StarkProgressIndicatorFullConfig> the new state of the progress indicator

results matching ""

    No results matching ""