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

Index

src/modules/message-pane/actions/message-pane.actions.ts

addMessages
Default value : createAction(`[${actionKey}] Add Messages`, props<{ messages: StarkMessage[] }>())

Triggered when the addMessages() method is called.

Parameter:

  • messages - The messages to add.
clearMessages
Default value : createAction(`[${actionKey}] Clear Messages`)

Triggered when the clearMessages() method is called.
getAllMessages
Default value : createAction(`[${actionKey}] Get All Messages`)

Triggered when the getAllMessages() method is called.
removeMessages
Default value : createAction(`[${actionKey}] Remove Messages`, props<{ messages: StarkMessage[] }>())

Triggered when the removeMessages() method is called.

Parameter:

  • messages - The messages to remove.

src/common/translations/common-translations.ts

commonUiTranslations
Type : object[]
Default value : []

Common translations for features available in Stark-Ui package

src/modules/message-pane/components/message-pane.component.ts

DEFAULT_ALIGN
Type : AlignTypes
Default value : "right"

The default align

src/modules/collapsible/components/collapsible.component.ts

DEFAULT_COLLAPSIBLE_ICON
Type : string
Default value : "chevron-right"

The default icon for a collapsible

src/modules/table/components/table.component.ts

DEFAULT_COLUMN_PROPERTIES
Type : Partial<StarkTableColumnProperties>
Default value : { isFilterable: true, isSortable: true, isVisible: true }

The default values set for StarkTableColumnProperties
defaultFilter
Type : StarkTableFilter
Default value : { globalFilterPresent: true, filterPosition: "below" }

Default filter StarkTableFilter configuration

src/modules/date-picker/components/date-picker.component.ts

DEFAULT_DATE_MASK_CONFIG
Type : miscellaneous
Default value : { format: "DD/MM/YYYY" }

Default date mask configuration used by the StarkDatePickerComponent

src/modules/input-mask-directives/directives/timestamp-mask.directive.ts

DEFAULT_DATE_TIME_FORMAT
Type : string
Default value : "DD-MM-YYYY HH:mm:ss"

The Time date format that is used when no other is specified.

src/modules/app-menu/components/app-menu-item.component.ts

DEFAULT_MENU_GROUP
Type : StarkMenuGroup
Default value : { id: "", label: "", isVisible: false, isEnabled: false }

Default value for MenuGroup

src/modules/date-time-picker/components/date-time-picker.component.ts

DEFAULT_TIME_MASK_CONFIG
Type : StarkTimestampMaskConfig
Default value : { format: "HH:mm:ss" }

Default TimeMask configuration

src/modules/generic-search/classes/abstract-search-component.ts

defaultProgressIndicatorConfig
Type : StarkProgressIndicatorConfig
Default value : { topic: "", type: StarkProgressIndicatorType.SPINNER }

Default progress indicator configuration

src/modules/progress-indicator/actions/progress-indicator.actions.ts

deregister
Default value : createAction(`[${starkProgressIndicatorStoreKey}] Deregister`, props<{ topic: string }>())

Triggered by the StarkProgressIndicatorService deregister() method.

Parameter:

  • topic - The topic of the indicator
hide
Default value : createAction(`[${starkProgressIndicatorStoreKey}] Hide`, props<{ topic: string }>())

Triggered by the StarkProgressIndicatorService hide() method.

Parameter:

  • topic - The topic of the indicator
register
Default value : createAction( `[${starkProgressIndicatorStoreKey}] Register`, props<{ progressIndicatorConfig: StarkProgressIndicatorFullConfig }>() )

Triggered by the StarkProgressIndicatorService register() method.

Parameter:

  • progressIndicatorConfig - Configuration of the indicator
show
Default value : createAction(`[${starkProgressIndicatorStoreKey}] Show`, props<{ topic: string }>())

Triggered by the StarkProgressIndicatorService show() method.

Parameter:

  • topic - The topic of the indicator

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

INITIAL_MESSAGES_STATE
Type : Readonly<StarkMessageCollection>
Default value : { infoMessages: [], warningMessages: [], errorMessages: [] }

Initial state of the store
reducer
Default value : createReducer<StarkMessageCollection, StarkMessagePaneActions.Types>( INITIAL_MESSAGES_STATE, on(StarkMessagePaneActions.addMessages, (state, action) => addMessage(state, action)), on(StarkMessagePaneActions.clearMessages, (state) => clearMessages(state)), on(StarkMessagePaneActions.removeMessages, (state, action) => removeMessages(state, action)) )

Definition of the reducer using createReducer method.

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

INITIAL_PROGRESS_INDICATOR_STATE
Type : Map<string, StarkProgressIndicatorFullConfig>
Default value : new Map<string, StarkProgressIndicatorFullConfig>()

Initial state of the reducer
reducer
Default value : createReducer<Map<string, StarkProgressIndicatorFullConfig>, StarkProgressIndicatorActions.Types>( INITIAL_PROGRESS_INDICATOR_STATE, // on(StarkProgressIndicatorActions.register || StarkProgressIndicatorActions.deregister || StarkProgressIndicatorActions.show || StarkProgressIndicatorActions.hide, (state) => cloneDeep(state)), on(StarkProgressIndicatorActions.register, (_state, action) => { // the new state will be calculated from the data coming in the actions let state = cloneDeep(_state); const topic = action.progressIndicatorConfig.topic; if (state.has(topic)) { const progressIndicatorConfig = cloneDeep(<StarkProgressIndicatorFullConfig>state.get(topic)); progressIndicatorConfig.listenersCount = <number>progressIndicatorConfig.listenersCount + 1; state = state.set(topic, progressIndicatorConfig); } else { state = state.set(topic, action.progressIndicatorConfig); } return state; }), on(StarkProgressIndicatorActions.deregister, (_state, action) => { // the new state will be calculated from the data coming in the actions let state = cloneDeep(_state); const topic = action.topic; if (state.has(topic)) { const progressIndicatorConfig = cloneDeep(<StarkProgressIndicatorFullConfig>state.get(topic)); progressIndicatorConfig.listenersCount = <number>progressIndicatorConfig.listenersCount - 1; if (progressIndicatorConfig.listenersCount === 0) { state.delete(topic); } else { state = state.set(topic, progressIndicatorConfig); } } return state; }), on(StarkProgressIndicatorActions.show, (_state, action) => { // the new state will be calculated from the data coming in the actions let state = cloneDeep(_state); const topic = action.topic; if (state.has(topic)) { const progressIndicatorConfig = cloneDeep(<StarkProgressIndicatorFullConfig>state.get(topic)); progressIndicatorConfig.visible = true; progressIndicatorConfig.pendingListenersCount = <number>progressIndicatorConfig.pendingListenersCount + 1; state = state.set(topic, progressIndicatorConfig); } return state; }), on(StarkProgressIndicatorActions.hide, (_state, action) => { // the new state will be calculated from the data coming in the actions let state = cloneDeep(_state); const topic = action.topic; if (state.has(topic)) { const progressIndicatorConfig = cloneDeep(<StarkProgressIndicatorFullConfig>state.get(topic)); if (<number>progressIndicatorConfig.pendingListenersCount > 0) { progressIndicatorConfig.pendingListenersCount = <number>progressIndicatorConfig.pendingListenersCount - 1; } if (<number>progressIndicatorConfig.pendingListenersCount === 0) { progressIndicatorConfig.visible = false; } state = state.set(topic, progressIndicatorConfig); } return state; }) )

Definition of the reducer using createReducer method.

src/modules/transform-input-directive/directives/transform-input.directive.ts

LOWERCASE
Type : lowercase
Default value : "lowercase"

The constant that contains the command for StarkTransformInputDirective to transform the input value in an element to lowercase.
STARK_TRANSFORM_INPUT_PROVIDER
Type : Provider
Default value : { provide: NG_VALUE_ACCESSOR, // eslint-disable-next-line @angular-eslint/no-forward-ref useExisting: forwardRef(() => StarkTransformInputDirective), multi: true }

Provider for StarkTransformInputDirective
UPPERCASE
Type : uppercase
Default value : "uppercase"

The constant that contains the command for StarkTransformInputDirective to transform the input value in an element to uppercase.

src/modules/pretty-print/services/pretty-print.service.ts

prismClassPrefix
Type : string
Default value : "language-"

The prefix used in the PrismJs CSS classes

src/modules/message-pane/reducers/index.ts

selectStarkMessages
Default value : createSelector( createFeatureSelector<StarkMessageState>(starkMessagePaneStoreKey), (state: StarkMessageState) => state.messages )

NGRX Selector for the StarkMessagePaneModule's state
starkMessagesReducers
Type : ActionReducerMap<StarkMessageState, StarkMessagePaneActions.Types>
Default value : { /** * Reducer assigned to the state's `messages` property */ messages: messagesReducer }

Reducers assigned to the each property of the StarkMessagePaneModule's state

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

selectStarkProgressIndicator
Default value : createSelector( createFeatureSelector<StarkProgressIndicatorState>(starkProgressIndicatorStoreKey), (state: StarkProgressIndicatorState) => state.progressIndicator )

NGRX Selector for the StarkProgressIndicatorModule's state
starkProgressIndicatorReducers
Type : ActionReducerMap<StarkProgressIndicatorState, StarkProgressIndicatorActions.Types>
Default value : { /** * Reducer assigned to the state's `progressIndicator` property */ progressIndicator: progressIndicatorReducer }

Reducers assigned to the each property of the StarkProgressIndicatorModule's state

src/modules/session-ui/routes.ts

SESSION_UI_STATES
Type : Ng2StateDeclaration[]
Default value : [ { name: starkLoginStateName, // the parent is defined in the state's name (contains a dot) url: starkLoginStateUrl, views: { "initOrExit@": { component: StarkLoginPageComponent } } }, { name: starkPreloadingStateName, // the parent is defined in the state's name (contains a dot) url: starkPreloadingStateUrl, views: { "initOrExit@": { component: StarkPreloadingPageComponent } } }, { name: starkSessionExpiredStateName, // the parent is defined in the state's name (contains a dot) url: starkSessionExpiredStateUrl, views: { "initOrExit@": { component: StarkSessionExpiredPageComponent } }, onEnter: destroyOverlaysOnEnterFn }, { name: starkSessionLogoutStateName, // the parent is defined in the state's name (contains a dot) url: starkSessionLogoutStateUrl, views: { "initOrExit@": { component: StarkSessionLogoutPageComponent } }, onEnter: destroyOverlaysOnEnterFn } ]

States defined by Session-UI Module

src/modules/app-sidebar/services/app-sidebar.service.intf.ts

STARK_APP_SIDEBAR_SERVICE
Type : InjectionToken<StarkAppSidebarService>
Default value : new InjectionToken<StarkAppSidebarService>( starkAppSidebarServiceName )

://v12.angular.io/api/core/InjectionToken|InjectionTokenhttps used to provide the StarkAppSidebarService

src/modules/date-picker/components/date-format.constants.ts

STARK_DATE_FORMATS
Type : MatDateFormats
Default value : { parse: { /** * Defines the dateInput parser for date-picker component. * This can be a string for a single value or an array for multiple possibilities (ordered by priority). * In case of array, if we have `dateInput: ["DD/MM/YYYY", "MM/DD/YYYY"]` * If we set the date "02/10/2019", the result date will be "October 2, 2019" and not "February 10, 2019". * Of course, if we set the date "02/20/2019", it will result in "February 20, 2019" because cannot be parsed with "DD/MM/YYYY". */ dateInput: ["DD/MM/YYYY", "LL"] }, display: { dateInput: "LL", monthYearLabel: "MMM YYYY", dateA11yLabel: "LL", monthYearA11yLabel: "MMMM YYYY" } }

Object containing the format of the dates displayed in the date picker Because we are using MomentJS internally, we are waiting for MomentJS formats in the configuration. All formats can be found here: https://momentjs.com/docs/#/displaying/

src/modules/svg-view-box/directives/svg-view-box.directive.ts

STARK_DEFAULT_VIEW_BOX_SIZE
Type : number
Default value : 24

Default value for the width and height of the 'viewBox' attribute if it is not given as an input.

src/modules/message-pane/services/message-pane.service.intf.ts

STARK_MESSAGE_PANE_SERVICE
Type : InjectionToken<StarkMessagePaneService>
Default value : new InjectionToken<StarkMessagePaneService>( starkMessagePaneServiceName )

://v12.angular.io/api/core/InjectionToken|InjectionTokenhttps used to provide the StarkMessagePaneService

src/modules/pretty-print/services/pretty-print.service.intf.ts

STARK_PRETTY_PRINT_SERVICE
Type : InjectionToken<StarkPrettyPrintService>
Default value : new InjectionToken<StarkPrettyPrintService>( starkPrettyPrintServiceName )

://v12.angular.io/api/core/InjectionToken|InjectionTokenhttps used to provide the StarkPrettyPrintService

src/modules/progress-indicator/services/progress-indicator.service.intf.ts

STARK_PROGRESS_INDICATOR_SERVICE
Type : InjectionToken<StarkProgressIndicatorService>
Default value : new InjectionToken<StarkProgressIndicatorService>(starkProgressIndicatorServiceName)

://v12.angular.io/api/core/InjectionToken|InjectionTokenhttps used to provide the StarkProgressIndicatorService

src/modules/session-ui/entities/stark-session-ui-config.ts

STARK_SESSION_UI_CONFIG
Type : InjectionToken<StarkSessionUiConfig>
Default value : new InjectionToken<StarkSessionUiConfig>( "StarkSessionUiConfig" )

://v12.angular.io/api/core/InjectionToken|InjectionTokenhttps used to provide the StarkSessionUiConfig

src/modules/toast-notification/services/toast-notification-option.intf.ts

STARK_TOAST_NOTIFICATION_OPTIONS
Type : InjectionToken<StarkToastNotificationOptions>
Default value : new InjectionToken<StarkToastNotificationOptions>("StarkToastNotificationOptions")

://v12.angular.io/api/core/InjectionToken|InjectionTokenhttps used to provide the StarkToastNotificationPosition

src/modules/toast-notification/services/toast-notification.service.intf.ts

STARK_TOAST_NOTIFICATION_SERVICE
Type : InjectionToken<StarkToastNotificationService>
Default value : new InjectionToken<StarkToastNotificationService>(starkToastNotificationServiceName)

://v12.angular.io/api/core/InjectionToken|InjectionTokenhttps used to provide the StarkToastNotificationService

src/modules/message-pane/components/message-pane.constants.ts

starkMessagePaneAlignClassPrefix
Type : string
Default value : "align-"

message pane align prefix
starkMessagePaneCollapsedClass
Type : string
Default value : "collapsed"

message pane collapsed
starkMessagePaneDisplayAnimatedClass
Type : string
Default value : "display-animated"

message pane display animated
starkMessagePaneDisplayedClass
Type : string
Default value : "displayed"

message pane displayed class

src/modules/message-pane/constants/message-pane-store-key.ts

starkMessagePaneStoreKey
Type : string
Default value : "StarkMessagePane"

Key defined to find the service in a store

src/modules/progress-indicator/constants/progress-indicator-store-key.ts

starkProgressIndicatorStoreKey
Type : string
Default value : "StarkProgressIndicator"

Key defined to find the service in a store

results matching ""

    No results matching ""