import { KbqTimeRangeModule } from '@koobiq/components/time-range';

KbqTimeRange

componentСкопировать ссылку на KbqTimeRange
@Component({ selector: 'kbq-time-range' })
class KbqTimeRange<T> implements ControlValueAccessor {
    readonly minDate = input<T>();
    readonly maxDate = input<T>();
    readonly defaultRangeValue = input<KbqRangeValue<T>>();
    readonly availableTimeRangeTypes = input<KbqTimeRangeType[]>(
        this.timeRangeService.providedDefaultTimeRangeTypes
    );
    readonly titleTemplate = input<TemplateRef<KbqTimeRangeCustomizableTitleContext>>();
    readonly optionTemplate = input<TemplateRef<KbqTimeRangeOptionContext>>();
    readonly arrow = input<boolean>(true);
    readonly showRangeAsDefault = input<boolean>(true);
    readonly nonNullable = input<boolean>(true);
    readonly valueCorrected = output<KbqTimeRangeRange>();
    readonly value: Signal<KbqTimeRangeRange | null>;
    readonly disabled: Signal<boolean>;
    onVisibleChange(isVisible: boolean): void;
}
minDateinputСкопировать ссылку на minDateT

The earliest date the calendars offer and the validation accepts.

maxDateinputСкопировать ссылку на maxDateT

The latest date the calendars offer and the validation accepts.

defaultRangeValueinputСкопировать ссылку на defaultRangeValueKbqRangeValue<T>

Seeds the from/to pair of the manual range.

availableTimeRangeTypesinputСкопировать ссылку на availableTimeRangeTypesKbqTimeRangeType[]

The options the editor offers, in order. The first one is selected by default.

titleTemplateinputСкопировать ссылку на titleTemplateTemplateRef<KbqTimeRangeCustomizableTitleContext>

Replaces the built-in trigger.

optionTemplateinputСкопировать ссылку на optionTemplateTemplateRef<KbqTimeRangeOptionContext>

Replaces the built-in rendering of an option in the editor.

arrowinputСкопировать ссылку на arrowboolean

Whether the popover is drawn with an arrow.

showRangeAsDefaultinputСкопировать ссылку на showRangeAsDefaultboolean

Keeps the manual range visible even when range is not in availableTimeRangeTypes.

nonNullableinputСкопировать ссылку на nonNullableboolean

Falls back to a default value instead of holding null.

localeOverridesinputСкопировать ссылку на localeOverridesKbqPartialLocaleData | undefined

Localized strings for this element and its subtree, keyed by locale section. Every key is optional at every depth.

valueCorrectedoutputСкопировать ссылку на valueCorrectedKbqTimeRangeRange

Emits the corrected value when the provided one could not be used as is.

valueСкопировать ссылку на valueSignal<KbqTimeRangeRange | null>

The applied time range, or null when the component is nullable and holds no value.

This is what the trigger renders, so it lags the editor until Apply.

disabledСкопировать ссылку на disabledSignal<boolean>

Whether the control is disabled through the forms layer.

KbqTimeRangeTitleAsControl

componentСкопировать ссылку на KbqTimeRangeTitleAsControl

Component simulates KbqFormFieldControl allowing to provide custom content inside KbqFormField

@Component({ selector: 'kbq-time-range-title-as-control' })
class KbqTimeRangeTitleAsControl implements KbqFormFieldControl<KbqTimeRangeRange> {}

KbqTimeRangeTitlePlaceholder

directiveСкопировать ссылку на KbqTimeRangeTitlePlaceholder

Directive for easy using styles of time-range placeholder publicly.

@Directive({ selector: '[kbqTimeRangeTitlePlaceholder]' })
class KbqTimeRangeTitlePlaceholder {}

KbqCustomTimeRangeType

typeСкопировать ссылку на KbqCustomTimeRangeType
type KbqCustomTimeRangeType = {
    type: KbqTimeRangeType | string;
    units: KbqTimeRangeUnits;
    translationType: KbqTimeRangeTranslationType;
    range?: KbqRange;
};
typeСкопировать ссылку на typeKbqTimeRangeType | string

time range identifier. Used as config key

translationTypeСкопировать ссылку на translationTypeKbqTimeRangeTranslationType

Property representing duration output unit

rangeoptionalСкопировать ссылку на rangeKbqRange

Custom range of start/end date-times

KbqRange

typeСкопировать ссылку на KbqRange

Represents a time range with optional start and end date-time values. Used as a range value by default.

type KbqRange = {
    startDateTime?: string;
    endDateTime?: string;
};

KbqRangeValue

interfaceСкопировать ссылку на KbqRangeValue

Represents a time range with optional start and end date-time values. Used as a form value when range in popover change.

interface KbqRangeValue<T> {
    fromTime?: T;
    fromDate?: T;
    toTime?: T;
    toDate?: T;
}

KbqTimeRangeCustomizableTitleContext

typeСкопировать ссылку на KbqTimeRangeCustomizableTitleContext

Context for a time range trigger customization, combining meta information.

type KbqTimeRangeCustomizableTitleContext = Partial<KbqTimeRangeTitleContext> & {
    $implicit: Partial<KbqTimeRangeTitleContext> & { formattedDate: string; popover: KbqPopoverTrigger };
} & { formattedDate: string; popover: KbqPopoverTrigger };

KbqTimeRangeOptionContext

typeСкопировать ссылку на KbqTimeRangeOptionContext

Context for a time range option customization, combining meta information.

type KbqTimeRangeOptionContext = KbqTimeRangeTypeContext & KbqTimeRangeUnits & {
    translationType: KbqTimeRangeTranslationType;
    formattedValue: string;
};

KbqTimeRangeRange

typeСкопировать ссылку на KbqTimeRangeRange

Main range information. Used for a popover date range selection, when selected type is range, and for trigger information calculation.

type KbqTimeRangeRange = KbqRange & KbqTimeRangeTypeContext;

KbqTimeRangeTitleContext

typeСкопировать ссылку на KbqTimeRangeTitleContext

Context for a time range trigger, combining range info and type.

type KbqTimeRangeTitleContext = KbqTimeRangeRange & KbqTimeRangeUnits;

KbqTimeRangeTranslationType

typeСкопировать ссылку на KbqTimeRangeTranslationType

Property representing duration output unit

type KbqTimeRangeTranslationType = Exclude<DurationUnit, 'quarters' | 'milliseconds'> | 'other';

KbqTimeRangeType

typeСкопировать ссылку на KbqTimeRangeType

Default accepted “time‑range” identifiers.

type KbqTimeRangeType = | 'lastMinute'
    | 'last5Minutes'
    | 'last15Minutes'
    | 'last30Minutes'
    | 'lastHour'
    | 'last24Hours'
    | 'last3Days'
    | 'last7Days'
    | 'last14Days'
    | 'last30Days'
    | 'last3Months'
    | 'last12Months'
    | 'allTime'
    | 'currentQuarter'
    | 'currentYear'
    | 'range';

KbqTimeRangeTypeContext

typeСкопировать ссылку на KbqTimeRangeTypeContext

Range type selected

type KbqTimeRangeTypeContext = {
    type: KbqTimeRangeType;
};

KbqTimeRangeUnits

interfaceСкопировать ссылку на KbqTimeRangeUnits

Configuration for a custom time range with duration metadata. Defines a time range with its identifier, duration units, and optional fixed date range.

interface KbqTimeRangeUnits extends DurationObjectUnits {
    years?: number;
    quarters?: number;
    months?: number;
    weeks?: number;
    days?: number;
    hours?: number;
    minutes?: number;
    seconds?: number;
    milliseconds?: number;
}

defaultTimeRangeTypes

constСкопировать ссылку на defaultTimeRangeTypes

Time range types in range editor if nothing provided

const defaultTimeRangeTypes: KbqTimeRangeType[];

KBQ_CUSTOM_TIME_RANGE_TYPES

constСкопировать ссылку на KBQ_CUSTOM_TIME_RANGE_TYPES

Preset of custom time ranges, provided by DI.

const KBQ_CUSTOM_TIME_RANGE_TYPES: InjectionToken<KbqCustomTimeRangeType[]>;

KBQ_DEFAULT_TIME_RANGE_TYPES

constСкопировать ссылку на KBQ_DEFAULT_TIME_RANGE_TYPES

Preset of selectable time ranges, provided by DI.

const KBQ_DEFAULT_TIME_RANGE_TYPES: InjectionToken<KbqTimeRangeType[]>;

KBQ_TIME_RANGE_LOCALE_CONFIGURATION

constСкопировать ссылку на KBQ_TIME_RANGE_LOCALE_CONFIGURATION

Localization configuration provider.

const KBQ_TIME_RANGE_LOCALE_CONFIGURATION: InjectionToken<KbqTimeRangeLocaleConfiguration>;

kbqTimeRangeLocaleConfigurationProvider

constСкопировать ссылку на kbqTimeRangeLocaleConfigurationProvider

Utility provider for KBQ_TIME_RANGE_LOCALE_CONFIGURATION. Only the strings you pass are overridden; the rest keep following the active locale.

const kbqTimeRangeLocaleConfigurationProvider: (
    configuration: KbqDeepPartial<KbqTimeRangeLocaleConfiguration>
) => Provider;

rangeValidator

constСкопировать ссылку на rangeValidator

Validates that the 'from' date-time is not greater than the 'to' date-time in a range form. Returns an error if the start date-time occurs after the end date-time.

const rangeValidator: <T>(
    timeRangeService: KbqTimeRangeService<T>
) => ValidatorFn;
Предложения по улучшению
Если вы нашли ошибку или хотите доработать статью, создайте запрос на GitHub.