Skip to content

Commit

Permalink
feat(config): add scroll strategy provider module override config (#556)
Browse files Browse the repository at this point in the history
  • Loading branch information
Igor Milly authored and GitHub Enterprise committed Mar 17, 2022
1 parent 4785962 commit c78c775
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 11 deletions.
36 changes: 25 additions & 11 deletions projects/ng-aquila/src/config/nx-scroll-strategy.helpers.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,23 +26,37 @@ export function getScrollStrategyFactory(preset: NxScrollStrategy, overlay: Over

/** Return an array of scroll strategy providers based on the provided default config. */
export function getScrollStrategyDefaultProviders(config: NxScrollStrategyDefaultConfig): FactoryProvider[] {
const scrollStrategyFactory = (overlay: Overlay) => getScrollStrategyFactory(config.scrollStrategy, overlay, config.scrollStrategyOptions);
return [
{ provide: NX_AUTOCOMPLETE_SCROLL_STRATEGY, useFactory: scrollStrategyFactory, deps: [Overlay] },
{ provide: NX_CONTEXT_MENU_SCROLL_STRATEGY, useFactory: scrollStrategyFactory, deps: [Overlay] },
{ provide: NX_DATEPICKER_SCROLL_STRATEGY, useFactory: scrollStrategyFactory, deps: [Overlay] },
{ provide: NX_DROPDOWN_SCROLL_STRATEGY, useFactory: scrollStrategyFactory, deps: [Overlay] },
{ provide: NX_NOTIFICATION_PANEL_SCROLL_STRATEGY, useFactory: scrollStrategyFactory, deps: [Overlay] },
{ provide: NX_AUTOCOMPLETE_SCROLL_STRATEGY, useFactory: getFactoryFnByDefaultConfig(config, 'autocomplete'), deps: [Overlay] },
{ provide: NX_CONTEXT_MENU_SCROLL_STRATEGY, useFactory: getFactoryFnByDefaultConfig(config, 'contextMenu'), deps: [Overlay] },
{ provide: NX_DATEPICKER_SCROLL_STRATEGY, useFactory: getFactoryFnByDefaultConfig(config, 'datepicker'), deps: [Overlay] },
{ provide: NX_DROPDOWN_SCROLL_STRATEGY, useFactory: getFactoryFnByDefaultConfig(config, 'dropdown'), deps: [Overlay] },
{ provide: NX_NOTIFICATION_PANEL_SCROLL_STRATEGY, useFactory: getFactoryFnByDefaultConfig(config, 'notificationPanel'), deps: [Overlay] },
];
}

function getFactoryFnByDefaultConfig(
config: NxScrollStrategyDefaultConfig,
componentName: keyof (NxScrollStrategyDefaultConfig['overrides'] & Record<never, never>),
): (overlay: Overlay) => () => ScrollStrategy {
const componentConfig = config.overrides?.[componentName] ?? config;
return (overlay: Overlay) => getScrollStrategyFactory(componentConfig.scrollStrategy, overlay, componentConfig.scrollStrategyOptions);
}

/** Return an array of scroll strategy providers based on the provided factory config. */
export function getScrollStrategyFactoryProviders(config: NxScrollStrategyFactoryConfig): FactoryProvider[] {
return [
{ provide: NX_AUTOCOMPLETE_SCROLL_STRATEGY, useFactory: config.scrollStrategyFactory, deps: [Overlay] },
{ provide: NX_CONTEXT_MENU_SCROLL_STRATEGY, useFactory: config.scrollStrategyFactory, deps: [Overlay] },
{ provide: NX_DATEPICKER_SCROLL_STRATEGY, useFactory: config.scrollStrategyFactory, deps: [Overlay] },
{ provide: NX_DROPDOWN_SCROLL_STRATEGY, useFactory: config.scrollStrategyFactory, deps: [Overlay] },
{ provide: NX_NOTIFICATION_PANEL_SCROLL_STRATEGY, useFactory: config.scrollStrategyFactory, deps: [Overlay] },
{ provide: NX_AUTOCOMPLETE_SCROLL_STRATEGY, useFactory: getFactoryFnByFactoryConfig(config, 'autocomplete'), deps: [Overlay] },
{ provide: NX_CONTEXT_MENU_SCROLL_STRATEGY, useFactory: getFactoryFnByFactoryConfig(config, 'contextMenu'), deps: [Overlay] },
{ provide: NX_DATEPICKER_SCROLL_STRATEGY, useFactory: getFactoryFnByFactoryConfig(config, 'datepicker'), deps: [Overlay] },
{ provide: NX_DROPDOWN_SCROLL_STRATEGY, useFactory: getFactoryFnByFactoryConfig(config, 'dropdown'), deps: [Overlay] },
{ provide: NX_NOTIFICATION_PANEL_SCROLL_STRATEGY, useFactory: getFactoryFnByFactoryConfig(config, 'notificationPanel'), deps: [Overlay] },
];
}

function getFactoryFnByFactoryConfig(
config: NxScrollStrategyFactoryConfig,
componentName: keyof (NxScrollStrategyDefaultConfig['overrides'] & Record<never, never>),
): (overlay: Overlay) => () => ScrollStrategy {
return (config.overrides?.[componentName] ?? config).scrollStrategyFactory;
}
19 changes: 19 additions & 0 deletions projects/ng-aquila/src/config/nx-scroll-strategy.models.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,35 @@ export type NxScrollStrategy = 'reposition' | 'block' | 'close' | 'noop';
/** Scroll strategy default preset options for overlay-based components. */
export type NxScrollStrategyOptions = RepositionScrollStrategyConfig & CloseScrollStrategyConfig;

/** Scroll strategy default configuration. */
export interface NxScrollStrategyDefaultConfig {
/** Preset for strategy factory that will be used to handle scrolling while a panel is open. */
scrollStrategy: NxScrollStrategy;
/** Additional strategy preset options. */
scrollStrategyOptions?: NxScrollStrategyOptions;
/** Override default config for each component type separately. */
overrides?: {
autocomplete?: Pick<NxScrollStrategyDefaultConfig, 'scrollStrategy' | 'scrollStrategyOptions'>;
contextMenu?: Pick<NxScrollStrategyDefaultConfig, 'scrollStrategy' | 'scrollStrategyOptions'>;
datepicker?: Pick<NxScrollStrategyDefaultConfig, 'scrollStrategy' | 'scrollStrategyOptions'>;
dropdown?: Pick<NxScrollStrategyDefaultConfig, 'scrollStrategy' | 'scrollStrategyOptions'>;
notificationPanel?: Pick<NxScrollStrategyDefaultConfig, 'scrollStrategy' | 'scrollStrategyOptions'>;
};
}

/** Scroll strategy factory creator function. */
export type NxScrollStrategyFactoryFn = (overlay: Overlay) => () => ScrollStrategy;

/** Scroll strategy factory configuration. */
export interface NxScrollStrategyFactoryConfig {
/** Creator function for strategy factory that will be used to handle scrolling while a panel is open. */
scrollStrategyFactory: NxScrollStrategyFactoryFn;
/** Override default config for each component type separately. */
overrides?: {
autocomplete?: Pick<NxScrollStrategyFactoryConfig, 'scrollStrategyFactory'>;
contextMenu?: Pick<NxScrollStrategyFactoryConfig, 'scrollStrategyFactory'>;
datepicker?: Pick<NxScrollStrategyFactoryConfig, 'scrollStrategyFactory'>;
dropdown?: Pick<NxScrollStrategyFactoryConfig, 'scrollStrategyFactory'>;
notificationPanel?: Pick<NxScrollStrategyFactoryConfig, 'scrollStrategyFactory'>;
};
}

0 comments on commit c78c775

Please sign in to comment.