@radix-ng/primitives 0.39.2 → 0.39.4

package/fesm2022/radix-ng-primitives-hover-card.mjs

@@ -37,6 +37,9 @@ var RdxHoverCardAnimationStatus;
     RdxHoverCardAnimationStatus["CLOSED_ENDED"] = "closed_ended";
 })(RdxHoverCardAnimationStatus || (RdxHoverCardAnimationStatus = {}));
 
+/**
+ * @group Components
+ */
 class RdxHoverCardContentDirective {
     constructor() {
         /** @ignore */
@@ -52,54 +55,71 @@ class RdxHoverCardContentDirective {
         /** @ignore */
         this.name = computed(() => `rdx-hover-card-trigger-${this.rootDirective.uniqueId()}`);
         /**
-         * @description The preferred side of the trigger to render against when open. Will be reversed when collisions occur and avoidCollisions is enabled.
-         * @default top
+         * The preferred side of the trigger to render against when open. Will be reversed when collisions occur and avoidCollisions is enabled.
+         * @group Props
+         * @defaultValue top
          */
         this.side = input(RdxPositionSide.Top);
         /**
-         * @description The distance in pixels from the trigger.
-         * @default undefined
+         * The distance in pixels from the trigger.
+         * @group Props
+         * @defaultValue undefined
          */
         this.sideOffset = input(NaN, {
             transform: numberAttribute
         });
         /**
-         * @description The preferred alignment against the trigger. May change when collisions occur.
-         * @default center
+         * The preferred alignment against the trigger. May change when collisions occur.
+         * @group Props
+         * @defaultValue center
          */
         this.align = input(RdxPositionAlign.Center);
         /**
-         * @description An offset in pixels from the "start" or "end" alignment options.
-         * @default undefined
+         * An offset in pixels from the "start" or "end" alignment options.
+         * @group Props
+         * @defaultValue undefined
          */
         this.alignOffset = input(NaN, {
             transform: numberAttribute
         });
         /**
-         * @description Whether to add some alternate positions of the content.
-         * @default false
+         * Whether to add some alternate positions of the content.
+         * @group Props
+         * @defaultValue false
          */
         this.alternatePositionsDisabled = input(false, { transform: booleanAttribute });
-        /** @description Whether to prevent `onOverlayEscapeKeyDown` handler from calling. */
+        /**
+         * Whether to prevent `onOverlayEscapeKeyDown` handler from calling.
+         * @group Props
+         * @defaultValue false
+         */
         this.onOverlayEscapeKeyDownDisabled = input(false, { transform: booleanAttribute });
-        /** @description Whether to prevent `onOverlayOutsideClick` handler from calling. */
+        /**
+         * Whether to prevent `onOverlayOutsideClick` handler from calling.
+         * @group Props
+         * @defaultValue false
+         */
         this.onOverlayOutsideClickDisabled = input(false, { transform: booleanAttribute });
         /**
-         * @description Event handler called when the escape key is down.
+         * Event handler called when the escape key is down.
          * It can be prevented by setting `onOverlayEscapeKeyDownDisabled` input to `true`.
+         * @group Emits
          */
         this.onOverlayEscapeKeyDown = output();
         /**
-         * @description Event handler called when a pointer event occurs outside the bounds of the component.
+         * Event handler called when a pointer event occurs outside the bounds of the component.
          * It can be prevented by setting `onOverlayOutsideClickDisabled` input to `true`.
+         * @group Emits
          */
         this.onOverlayOutsideClick = output();
         /**
-         * @description Event handler called after the overlay is open
+         * Event handler called after the overlay is open
+         * @group Emits
          */
         this.onOpen = output();
         /**
-         * @description Event handler called after the overlay is closed
+         * Event handler called after the overlay is closed
+         * @group Emits
          */
         this.onClosed = output();
         /** @ingore */
@@ -503,6 +523,9 @@ const provideRdxCdkEventService = () => getProvider(false);
 const injectRdxCdkEventService = () => inject(RdxCdkEventServiceToken, { optional: true });
 
 let nextId = 0;
+/**
+ * @group Components
+ */
 class RdxHoverCardRootDirective {
     constructor() {
         /** @ignore */
@@ -510,50 +533,61 @@ class RdxHoverCardRootDirective {
         /** @ignore */
         this.name = computed(() => `rdx-hover-card-root-${this.uniqueId()}`);
         /**
-         * @description The anchor directive that comes form outside the hover-card rootDirective
-         * @default undefined
+         * The anchor directive that comes from outside the hover-card rootDirective
+         * @group Props
+         * @defaultValue undefined
          */
         this.anchor = input(void 0);
         /**
-         * @description The open state of the hover-card when it is initially rendered. Use when you do not need to control its open state.
-         * @default false
+         * The open state of the hover-card when it is initially rendered. Use when you do not need to control its open state.
+         * @group Props
+         * @defaultValue false
          */
         this.defaultOpen = input(false, { transform: booleanAttribute });
         /**
-         * @description The controlled state of the hover-card. `open` input take precedence of `defaultOpen` input.
-         * @default undefined
+         * The controlled state of the hover-card. `open` input takes precedence over `defaultOpen` input.
+         * @group Props
+         * @defaultValue undefined
          */
         this.open = input(void 0, { transform: booleanAttribute });
         /**
-         * To customise the open delay for a specific hover-card.
+         * The delay in milliseconds before the hover-card opens.
+         * @group Props
+         * @defaultValue 500
          */
         this.openDelay = input(500, {
             transform: numberAttribute
         });
         /**
-         * To customise the close delay for a specific hover-card.
+         * The delay in milliseconds before the hover-card closes.
+         * @group Props
+         * @defaultValue 200
          */
         this.closeDelay = input(200, {
             transform: numberAttribute
         });
         /**
-         * @description Whether to control the state of the hover-card from external. Use in conjunction with `open` input.
-         * @default undefined
+         * Whether to control the state of the hover-card from outside. Use in conjunction with `open` input.
+         * @group Props
+         * @defaultValue undefined
          */
         this.externalControl = input(void 0, { transform: booleanAttribute });
         /**
-         * @description Whether to take into account CSS opening/closing animations.
-         * @default false
+         * Whether to take into account CSS opening/closing animations.
+         * @group Props
+         * @defaultValue false
          */
         this.cssAnimation = input(false, { transform: booleanAttribute });
         /**
-         * @description Whether to take into account CSS opening animations. `cssAnimation` input must be set to 'true'
-         * @default false
+         * Whether to take into account CSS opening animations. `cssAnimation` input must be set to 'true'
+         * @group Props
+         * @defaultValue false
          */
         this.cssOpeningAnimation = input(false, { transform: booleanAttribute });
         /**
-         * @description Whether to take into account CSS closing animations. `cssAnimation` input must be set to 'true'
-         * @default false
+         * Whether to take into account CSS closing animations. `cssAnimation` input must be set to 'true'
+         * @group Props
+         * @defaultValue false
          */
         this.cssClosingAnimation = input(false, { transform: booleanAttribute });
         /** @ignore */
@@ -920,6 +954,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "19.2.4", ngImpor
                 }]
         }] });
 
+/**
+ * @group Components
+ */
 class RdxHoverCardArrowDirective {
     constructor() {
         /** @ignore */
@@ -929,13 +966,15 @@ class RdxHoverCardArrowDirective {
         /** @ignore */
         this.elementRef = inject(ElementRef);
         /**
-         * @description The width of the arrow in pixels.
-         * @default 10
+         * The width of the arrow in pixels.
+         * @group Props
+         * @defaultValue 10
          */
         this.width = input(RDX_POSITIONING_DEFAULTS.arrow.width, { transform: numberAttribute });
         /**
-         * @description The height of the arrow in pixels.
-         * @default 5
+         * The height of the arrow in pixels.
+         * @group Props
+         * @defaultValue 5
          */
         this.height = input(RDX_POSITIONING_DEFAULTS.arrow.height, { transform: numberAttribute });
         /** @ignore */