@dereekb/dbx-web 12.6.12 → 12.6.14

package/lib/layout/text/text.module.d.ts

@@ -1,15 +1,17 @@
 import * as i0 from "@angular/core";
 import * as i1 from "./address.component";
 import * as i2 from "./number.limit.component";
-import * as i3 from "./text.chip.directive";
-import * as i4 from "./detail.block.component";
-import * as i5 from "./detail.block.header.component";
-import * as i6 from "./label.block.component";
-import * as i7 from "./linkify.component";
-import * as i8 from "./text.chips.component";
-import * as i9 from "./icon.spacer.component";
+import * as i3 from "./copy.text.directive";
+import * as i4 from "./copy.text.component";
+import * as i5 from "./text.chip.directive";
+import * as i6 from "./detail.block.component";
+import * as i7 from "./detail.block.header.component";
+import * as i8 from "./label.block.component";
+import * as i9 from "./linkify.component";
+import * as i10 from "./text.chips.component";
+import * as i11 from "./icon.spacer.component";
 export declare class DbxTextModule {
     static ɵfac: i0.ɵɵFactoryDeclaration<DbxTextModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<DbxTextModule, never, [typeof i1.DbxUnitedStatesAddressComponent, typeof i2.DbxNumberWithLimitComponent, typeof i3.DbxChipDirective, typeof i4.DbxDetailBlockComponent, typeof i5.DbxDetailBlockHeaderComponent, typeof i6.DbxLabelBlockComponent, typeof i7.DbxLinkifyComponent, typeof i8.DbxTextChipsComponent, typeof i9.DbxIconSpacerDirective], [typeof i1.DbxUnitedStatesAddressComponent, typeof i2.DbxNumberWithLimitComponent, typeof i3.DbxChipDirective, typeof i4.DbxDetailBlockComponent, typeof i5.DbxDetailBlockHeaderComponent, typeof i6.DbxLabelBlockComponent, typeof i7.DbxLinkifyComponent, typeof i8.DbxTextChipsComponent, typeof i9.DbxIconSpacerDirective]>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<DbxTextModule, never, [typeof i1.DbxUnitedStatesAddressComponent, typeof i2.DbxNumberWithLimitComponent, typeof i3.DbxClickToCopyTextDirective, typeof i4.DbxClickToCopyTextComponent, typeof i5.DbxChipDirective, typeof i6.DbxDetailBlockComponent, typeof i7.DbxDetailBlockHeaderComponent, typeof i8.DbxLabelBlockComponent, typeof i9.DbxLinkifyComponent, typeof i10.DbxTextChipsComponent, typeof i11.DbxIconSpacerDirective], [typeof i1.DbxUnitedStatesAddressComponent, typeof i2.DbxNumberWithLimitComponent, typeof i3.DbxClickToCopyTextDirective, typeof i4.DbxClickToCopyTextComponent, typeof i5.DbxChipDirective, typeof i6.DbxDetailBlockComponent, typeof i7.DbxDetailBlockHeaderComponent, typeof i8.DbxLabelBlockComponent, typeof i9.DbxLinkifyComponent, typeof i10.DbxTextChipsComponent, typeof i11.DbxIconSpacerDirective]>;
     static ɵinj: i0.ɵɵInjectorDeclaration<DbxTextModule>;
 }

package/lib/style/_config.scss

@@ -194,7 +194,9 @@ $default-notice-color: #f28600;
     // table enabled by default
     'table': 1,
     // zip enabled by default
-    'zip': 1
+    'zip': 1,
+    // help enabled by default
+    'help': 1
   );
 
   @if ($input-dbx-theme-extension-config != null) {
@@ -223,3 +225,7 @@ $default-notice-color: #f28600;
 @function get-dbx-extension-zip-enabled($theme-config) {
   @return get-dbx-extension-config-var($theme-config, 'zip');
 }
+
+@function get-dbx-extension-help-enabled($theme-config) {
+  @return get-dbx-extension-config-var($theme-config, 'help');
+}

package/lib/style/_root-variables.scss

@@ -32,6 +32,8 @@
     #{theming.$dbx-page-height-additional-offset-var}: 0px;
     #{theming.$dbx-content-height-additional-offset-var}: 0px;
 
+    #{theming.$dbx-content-pit-rounded-border-radius-var}: 12px;
+
     #{theming.$dbx-avatar-size-var}: theming.get-dbx-avatar-size($theme-config);
     #{theming.$dbx-avatar-large-size-var}: theming.get-dbx-avatar-large-size($theme-config);
     #{theming.$dbx-avatar-small-size-var}: theming.get-dbx-avatar-small-size($theme-config);

package/lib/style/_variables.scss

@@ -128,6 +128,9 @@ $dbx-grey-color-contrast: var($dbx-grey-color-contrast-var);
 $dbx-disabled-color-contrast: var($dbx-disabled-color-contrast-var);
 $dbx-bg-color-contrast: var($dbx-bg-color-contrast-var);
 
+$dbx-content-pit-rounded-border-radius-var: --dbx-content-pit-rounded-border-radius;
+$dbx-content-pit-rounded-border-radius: var($dbx-content-pit-rounded-border-radius-var);
+
 $dbx-avatar-size: var($dbx-avatar-size-var);
 $dbx-avatar-large-size: var($dbx-avatar-large-size-var);
 $dbx-avatar-small-size: var($dbx-avatar-small-size-var);

package/lib/util/clipboard.d.ts

@@ -0,0 +1,78 @@
+import { Clipboard } from '@angular/cdk/clipboard';
+import { type GetterOrValueWithInput, type Maybe, type Milliseconds, type Seconds } from '@dereekb/util';
+/**
+ * True if copying to the clipboard was successful.
+ */
+export type CopyToClipboardSuccess = boolean;
+/**
+ * Can only copy strings to the clipboard.
+ */
+export type CopyToClipboardContent = string;
+/**
+ * Copies the input text to the clipboard.
+ *
+ * @param content The content to copy.
+ * @returns A promise that resolves to true if the content was copied successfully, false otherwise.
+ */
+export type CopyToClipboardFunction = ((content: CopyToClipboardContent) => Promise<CopyToClipboardSuccess>) & {
+    readonly _clipboard: Clipboard;
+};
+export interface CopyToClipboardFunctionConfig {
+    readonly copyTimeoutSeconds?: Maybe<Seconds>;
+    readonly delayBetweenCopyAttempts?: Maybe<Milliseconds>;
+    readonly onCopyResult?: Maybe<(success: CopyToClipboardSuccess, content: CopyToClipboardContent) => void>;
+}
+/**
+ * Creates a copy to clipboard function.
+ *
+ * @param clipboard The clipboard to use.
+ * @param config Optional configuration.
+ * @returns The copy to clipboard function.
+ */
+export declare function copyToClipboardFunction(clipboard: Clipboard, config?: CopyToClipboardFunctionConfig): CopyToClipboardFunction;
+/**
+ * Injects a copy to clipboard function.
+ *
+ * Must be run in an Angular injection context.
+ *
+ * @param config
+ * @returns
+ */
+export declare function injectCopyToClipboardFunction(config?: CopyToClipboardFunctionConfig): CopyToClipboardFunction;
+/**
+ * Copies the input text to the clipboard.
+ *
+ * @param content The content to copy.
+ * @returns A promise that resolves to true if the content was copied successfully, false otherwise.
+ */
+export type CopyToClipboardFunctionWithSnackbarMessage = CopyToClipboardFunction & {
+    setSnackbarMessagesConfig(config: Maybe<CopyToClipboardFunctionWithSnackbarMessageSnackbarConfig>): void;
+    setSnackbarMessagesEnabled(enabled: boolean): void;
+};
+export interface CopyToClipboardFunctionWithSnackbarMessageSnackbarConfig {
+    /**
+     * The duration to show the snackbar for.
+     *
+     * Defaults to 3 seconds.
+     */
+    readonly snackbarDuration?: Milliseconds;
+    /**
+     * The message to show when the content is copied successfully.
+     */
+    readonly successMessage?: GetterOrValueWithInput<string, CopyToClipboardContent>;
+    /**
+     * The message to show when the content fails to copy.
+     */
+    readonly failureMessage?: GetterOrValueWithInput<string, CopyToClipboardContent>;
+}
+export interface CopyToClipboardFunctionWithSnackbarMessageConfig extends CopyToClipboardFunctionConfig, CopyToClipboardFunctionWithSnackbarMessageSnackbarConfig {
+}
+/**
+ * Injects a copy to clipboard function.
+ *
+ * Must be run in an Angular injection context.
+ *
+ * @param config
+ * @returns
+ */
+export declare function injectCopyToClipboardFunctionWithSnackbarMessage(config?: CopyToClipboardFunctionWithSnackbarMessageConfig): CopyToClipboardFunctionWithSnackbarMessage;

package/lib/util/clipboard.directive.d.ts

@@ -0,0 +1,12 @@
+import { Maybe } from '@dereekb/util';
+import { CopyToClipboardFunctionWithSnackbarMessageSnackbarConfig } from './clipboard';
+import * as i0 from "@angular/core";
+export declare class AbstractDbxClipboardDirective {
+    protected readonly _copyToClipboard: import("./clipboard").CopyToClipboardFunctionWithSnackbarMessage;
+    readonly clipboardSnackbarMessagesConfig: import("@angular/core").InputSignal<Maybe<CopyToClipboardFunctionWithSnackbarMessageSnackbarConfig>>;
+    readonly clipboardSnackbarMessagesEnabled: import("@angular/core").InputSignal<boolean>;
+    protected readonly _configEffect: import("@angular/core").EffectRef;
+    protected readonly _enabledEffect: import("@angular/core").EffectRef;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AbstractDbxClipboardDirective, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<AbstractDbxClipboardDirective, never, never, { "clipboardSnackbarMessagesConfig": { "alias": "clipboardSnackbarMessagesConfig"; "required": false; "isSignal": true; }; "clipboardSnackbarMessagesEnabled": { "alias": "clipboardSnackbarMessagesEnabled"; "required": false; "isSignal": true; }; }, {}, never, never, false, never>;
+}

package/lib/util/index.d.ts

@@ -1 +1,3 @@
 export * from './cdk';
+export * from './clipboard';
+export * from './clipboard.directive';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/dbx-web",
-  "version": "12.6.12",
+  "version": "12.6.14",
   "peerDependencies": {
     "@angular/common": "^18.0.0",
     "@angular/core": "^18.0.0",