ngx-com 0.0.20 → 0.0.21

package/types/ngx-com-components-separator.d.ts

@@ -0,0 +1,75 @@
+import * as i0 from '@angular/core';
+import { InputSignal, InputSignalWithTransform, Signal } from '@angular/core';
+import { VariantProps } from 'class-variance-authority';
+
+/**
+ * Orientation type for separator direction.
+ */
+type SeparatorOrientation = 'horizontal' | 'vertical';
+/**
+ * Variant type for separator appearance.
+ */
+type SeparatorVariant = 'default' | 'subtle';
+/**
+ * CVA variants for the separator directive.
+ *
+ * @tokens `--color-border`, `--color-border-subtle`
+ */
+declare const separatorVariants: (props?: {
+    orientation?: SeparatorOrientation;
+    variant?: SeparatorVariant;
+}) => string;
+type SeparatorVariants = VariantProps<typeof separatorVariants>;
+
+/**
+ * Separator directive — applies a visual divider to any host element.
+ *
+ * Works on `<hr>`, `<div>`, or any other element. Supports horizontal and
+ * vertical orientations, a subtle color variant, and a decorative mode that
+ * hides the separator from assistive technology.
+ *
+ * @tokens `--color-border`, `--color-border-subtle`
+ *
+ * @example Horizontal divider
+ * ```html
+ * <hr comSeparator />
+ * ```
+ *
+ * @example Vertical divider
+ * ```html
+ * <div comSeparator orientation="vertical" class="h-6"></div>
+ * ```
+ *
+ * @example Subtle variant
+ * ```html
+ * <hr comSeparator variant="subtle" />
+ * ```
+ *
+ * @example Decorative (hidden from screen readers)
+ * ```html
+ * <hr comSeparator decorative />
+ * ```
+ */
+declare class ComSeparator {
+    /** Direction of the separator line */
+    readonly orientation: InputSignal<SeparatorOrientation>;
+    /** Color intensity — `default` uses border-border, `subtle` uses border-border-subtle */
+    readonly variant: InputSignal<SeparatorVariant>;
+    /** When true, hides the separator from assistive technology */
+    readonly decorative: InputSignalWithTransform<boolean, unknown>;
+    /** Consumer CSS classes — merged with variant classes via mergeClasses() */
+    readonly userClass: InputSignal<string>;
+    /** @internal Computed host class from CVA + consumer overrides */
+    protected readonly computedClass: Signal<string>;
+    /** @internal Role attribute — separator when semantic, none when decorative */
+    protected readonly computedRole: Signal<string>;
+    /** @internal Aria-orientation — set only when not decorative */
+    protected readonly computedAriaOrientation: Signal<string | null>;
+    /** @internal Aria-hidden — true only when decorative */
+    protected readonly computedAriaHidden: Signal<'true' | null>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ComSeparator, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<ComSeparator, "[comSeparator]", ["comSeparator"], { "orientation": { "alias": "orientation"; "required": false; "isSignal": true; }; "variant": { "alias": "variant"; "required": false; "isSignal": true; }; "decorative": { "alias": "decorative"; "required": false; "isSignal": true; }; "userClass": { "alias": "class"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
+}
+
+export { ComSeparator, separatorVariants };
+export type { SeparatorOrientation, SeparatorVariant, SeparatorVariants };