@atlaskit/editor-plugin-date/dist/types-ts4.5/types/index.d.ts

Date plugin for @atlaskit/editor-core

import type { WeekDay } from '@atlaskit/calendar/types';
import type { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
import type { EditorCommand, NextEditorPlugin, OptionalPlugin, TOOLBAR_MENU_TYPE } from '@atlaskit/editor-common/types';
import type { analyticsPlugin } from '@atlaskit/editor-plugin-analytics';
import type { AnnotationPlugin } from '@atlaskit/editor-plugin-annotation';
import type { EditorDisabledPlugin } from '@atlaskit/editor-plugin-editor-disabled';
import type { EditorViewModePlugin } from '@atlaskit/editor-plugin-editor-viewmode';
export type DateSegment = 'day' | 'month' | 'year';
export type DateType = {
    day?: number;
    month: number;
    year: number;
};
export interface DatePluginOptions {
    weekStartDay?: WeekDay;
}
/**
 * @private
 * @deprecated Use {@link DatePluginOptions} instead.
 * @see https://product-fabric.atlassian.net/browse/ED-27496
 */
export type DatePluginConfig = DatePluginOptions;
export type DatePluginSharedState = {
    focusDateInput: boolean;
    isInitialised: boolean;
    isNew: boolean;
    showDatePickerAt?: number | null;
};
export type InsertDate = (props: {
    commitMethod?: INPUT_METHOD.PICKER | INPUT_METHOD.KEYBOARD;
    date?: DateType;
    enterPressed?: boolean;
    inputMethod?: TOOLBAR_MENU_TYPE;
}) => EditorCommand;
export type DeleteDate = EditorCommand;
export type DatePlugin = NextEditorPlugin<'date', {
    commands: {
        deleteDate: DeleteDate;
        insertDate: InsertDate;
    };
    dependencies: [
        typeof analyticsPlugin,
        EditorDisabledPlugin,
        OptionalPlugin<AnnotationPlugin>,
        OptionalPlugin<EditorViewModePlugin>
    ];
    pluginConfiguration: DatePluginOptions | undefined;
    sharedState: DatePluginSharedState;
}>;