@ngb-bootstrap/core 0.0.0 → 0.1.0-next.0

package/types/ngb-bootstrap-core.d.ts

@@ -0,0 +1,82 @@
+import { EnvironmentProviders, InjectionToken } from "@angular/core";
+/**
+ * Translatable strings used by the components. Values may contain `{name}` placeholders,
+ * which the component that uses them fills in (e.g. `{page}` in `pagination.page`).
+ */
+export interface NgbI18n {
+  /** Accessible label of close buttons (alerts, modals, drawers, toasts). */
+  close: string;
+  /** Accessible label of the clear button of text inputs. */
+  clear: string;
+  /** Accessible label of loading indicators (spinner, loading buttons). */
+  loading: string;
+  /** Accessible name of the toggle of a collapsed collapsible card. */
+  expand: string;
+  /** Accessible name of the toggle of an expanded collapsible card. */
+  collapse: string;
+  /** Strings of the Chips component. */
+  chip: {
+    /** Accessible name of the remove button. `{label}` is the chip's text. */
+    remove: string;
+  };
+  /** Reserved for the Pagination component. */
+  pagination: {
+    first: string;
+    previous: string;
+    next: string;
+    last: string;
+    page: string;
+  };
+  /** Reserved for the Datepicker component. */
+  datepicker: {
+    previousMonth: string;
+    nextMonth: string;
+    selectMonth: string;
+    selectYear: string;
+  };
+  /** Reserved for the File input component. */
+  file: {
+    browse: string;
+    noFileChosen: string;
+  };
+}
+/** Same shape as {@link NgbI18n}, with every key optional at every level. */
+export type NgbI18nOverrides = { [K in keyof NgbI18n]?: NgbI18n[K] extends string ? string : Partial<NgbI18n[K]>; };
+/** English strings, used when nothing else is provided. */
+export declare const NGB_DEFAULT_I18N: NgbI18n;
+/** Injects the active strings. Defaults to English. */
+export declare const NGB_I18N: InjectionToken<NgbI18n>;
+/** Merges overrides onto the English defaults (one level deep, matching {@link NgbI18n}). */
+export declare function mergeNgbI18n(overrides?: NgbI18nOverrides): NgbI18n;
+/**
+ * Overrides some or all library strings. Also available as `provideNgb({ i18n })`.
+ *
+ * ```ts
+ * providers: [provideNgbI18n({ close: 'Fermer', loading: 'Chargement…' })]
+ * ```
+ */
+export declare function provideNgbI18n(overrides: NgbI18nOverrides): EnvironmentProviders;
+/** Library-wide defaults. Each component also exposes its own config token. */
+export interface NgbConfig {
+  /** Disable all component animations (e.g. for tests or reduced-motion apps). */
+  animation: boolean;
+}
+/** Options accepted by {@link provideNgb}: the config plus translated strings. */
+export interface NgbOptions extends Partial<NgbConfig> {
+  /** Override library strings (see `NgbI18n`). */
+  i18n?: NgbI18nOverrides;
+}
+export declare const NGB_DEFAULT_CONFIG: NgbConfig;
+export declare const NGB_CONFIG: InjectionToken<NgbConfig>;
+/**
+ * Registers library-wide configuration.
+ *
+ * ```ts
+ * bootstrapApplication(App, {
+ *   providers: [provideNgb({ animation: false, i18n: { close: 'Fermer' } })],
+ * });
+ * ```
+ */
+export declare function provideNgb(options?: NgbOptions): EnvironmentProviders;
+/** Bootstrap 6 theme colours, applied with the `.theme-*` helper classes. */
+export type NgbThemeColor = 'primary' | 'accent' | 'secondary' | 'success' | 'danger' | 'warning' | 'info' | 'inverse';