@hubspot/ui-extensions 0.12.1 → 0.12.3

package/dist/shared/types/components/inputs.d.ts

@@ -1,4 +1,4 @@
-import { BaseComponentProps } from '../shared.ts';
+import type { BaseComponentProps } from '../shared.ts';
 /**
  * Generic collection of props for all inputs
  * @internal
@@ -80,7 +80,7 @@ interface BaseInputProps<T = string, V = string> extends BaseComponentProps {
     onFocus?: (value: V) => void;
 }
 /**
- * The props type for {@link !components.Input}.
+ * The props type for [Input](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/input).
  *
  * @category Component Props
  */
@@ -93,7 +93,7 @@ export interface InputProps extends BaseInputProps {
     type?: 'text' | 'password';
 }
 /**
- * The props type for {@link !components.TextArea}.
+ * The props type for [TextArea](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/text-area).
  *
  * @category Component Props
  */
@@ -130,7 +130,7 @@ export type TextareaProps = TextAreaProps;
  * */
 type BaseInputForNumber = Omit<BaseInputProps<number, number>, 'onInput'>;
 /**
- * The props type for {@link !components.NumberInput}.
+ * The props type for [NumberInput](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/number-input).
  *
  * @category Component Props
  */
@@ -157,7 +157,7 @@ export interface NumberInputProps extends BaseInputForNumber {
     onInput?: (value: number) => void;
 }
 /**
- * The props type for {@link !components.CurrencyInput}.
+ * The props type for [CurrencyInput](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/currency-input).
  *
  * @category Component Props
  */
@@ -181,7 +181,7 @@ export interface CurrencyInputProps extends BaseInputForNumber {
     max?: number;
 }
 /**
- * The props type for {@link !components.StepperInput}.
+ * The props type for [StepperInput](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/stepper-input).
  *
  * @category Component Props
  */
@@ -219,7 +219,7 @@ export interface DateInputEventsPayload extends BaseDate {
  * */
 type BaseDateInputForDate = Omit<BaseInputProps<BaseDate | null, DateInputEventsPayload>, 'onInput' | 'placeholder'>;
 /**
- * The props type for {@link !components.DateInput}.
+ * The props type for [DateInput](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/date-input).
  *
  * @category Component Props
  */
@@ -306,7 +306,7 @@ export interface TimeInputEventsPayload extends BaseTime {
  * */
 type BaseTimeInputForTime = Omit<BaseInputProps<BaseTime | null, TimeInputEventsPayload>, 'onInput' | 'placeholder' | 'onChange'>;
 /**
- * The props type for {@link !components.TimeInput}.
+ * The props type for [TimeInput](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/time-input).
  *
  * @category Component Props
  */
@@ -338,7 +338,7 @@ export interface TimeInputProps extends BaseTimeInputForTime {
     timezone?: 'userTz' | 'portalTz';
 }
 /**
- * The props type for {@link !components.SearchInput}.
+ * The props type for [SearchInput](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/search-input).
  *
  * @category Component Props
  */

package/dist/shared/types/components/layouts.d.ts

@@ -1,7 +1,7 @@
-import { ReactNode } from 'react';
-import { AllDistances, BaseComponentProps } from '../shared.ts';
+import type { ReactNode } from 'react';
+import type { AllDistances, BaseComponentProps } from '../shared.ts';
 /**
- * The props type for {@link !components.Stack}.
+ * The props type for [Stack](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/flex).
  *
  * @category Component Props
  */
@@ -34,7 +34,7 @@ export interface StackProps extends BaseComponentProps {
 export type FlexJustify = 'center' | 'end' | 'start' | 'around' | 'between';
 export type FlexAlign = 'start' | 'center' | 'baseline' | 'end' | 'stretch';
 /**
- * The props type for {@link !components.Flex}.
+ * The props type for [Flex](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/flex).
  *
  * @category Component Props
  */
@@ -80,7 +80,7 @@ export interface FlexProps extends BaseComponentProps {
     wrap?: boolean | 'wrap' | 'nowrap';
 }
 /**
- * The props type for {@link !components.Box}.
+ * The props type for [Box](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/box).
  *
  * @category Component Props
  */
@@ -108,7 +108,7 @@ export interface BoxProps extends BaseComponentProps {
     flex?: 'initial' | 'auto' | 'none' | number;
 }
 /**
- * The props type for {@link !components.Inline}.
+ * The props type for [Inline](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/inline).
  *
  * @category Component Props
  */
@@ -137,7 +137,7 @@ export interface InlineProps extends BaseComponentProps {
     gap?: AllDistances;
 }
 /**
- * The props type for {@link !components.AutoGrid}.
+ * The props type for [AutoGrid](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/autogrid).
  *
  * @category Component Props
  */

package/dist/shared/types/components/link.d.ts

@@ -1,8 +1,8 @@
-import { ReactNode } from 'react';
-import { OverlayComponentProps, ExtensionEvent, HrefProp, BaseComponentProps } from '../shared.ts';
-import { ReactionsHandler } from '../reactions.ts';
+import type { ReactNode } from 'react';
+import type { ReactionsHandler } from '../reactions.ts';
+import type { BaseComponentProps, ExtensionEvent, HrefProp, OverlayComponentProps } from '../shared.ts';
 /**
- * The props type for {@link !components.Link}.
+ * The props type for [Link](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/link).
  *
  * @category Component Props
  */
@@ -27,7 +27,8 @@ export interface LinkProps extends OverlayComponentProps, BaseComponentProps {
      */
     variant?: 'primary' | 'destructive' | 'light' | 'dark';
     /**
-     * A function that is invoked when the link is clicked. The function receives no arguments and its return value is ignored.
+     * A function that will be invoked when the button is clicked. It receives an event object and a reactions object
+     * with methods to control overlays. Its return value is ignored.
      *
      * @event
      */

package/dist/shared/types/components/list.d.ts

@@ -1,7 +1,7 @@
-import { ReactNode } from 'react';
-import { BaseComponentProps } from '../shared.ts';
+import type { ReactNode } from 'react';
+import type { BaseComponentProps } from '../shared.ts';
 /**
- * The props type for {@link !components.List}.
+ * The props type for [List](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/list).
  *
  * @category Component Props
  */

package/dist/shared/types/components/loading-spinner.d.ts

@@ -1,6 +1,6 @@
-import { TShirtSizes, BaseComponentProps } from '../shared.ts';
+import type { BaseComponentProps, TShirtSizes } from '../shared.ts';
 /**
- * The props type for {@link !components.LoadingSpinner}.
+ * The props type for [LoadingSpinner](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/loading-spinner).
  *
  * @category Component Props
  */

package/dist/shared/types/components/modal.d.ts

@@ -1,5 +1,5 @@
-import { ReactNode } from 'react';
-import { TShirtSizes, BaseComponentProps } from '../shared.ts';
+import type { ReactNode } from 'react';
+import type { BaseComponentProps, TShirtSizes } from '../shared.ts';
 export interface ModalProps extends BaseComponentProps {
     /**
      * The modal's accessibility label.

package/dist/shared/types/components/panel.d.ts

@@ -1,5 +1,5 @@
-import { ReactNode } from 'react';
-import { TShirtSizes, BaseComponentProps } from '../shared.ts';
+import type { ReactNode } from 'react';
+import type { BaseComponentProps, TShirtSizes } from '../shared.ts';
 export interface PanelProps extends BaseComponentProps {
     /**
      * The panel's accessibility label.

package/dist/shared/types/components/progress-bar.d.ts

@@ -1,6 +1,6 @@
-import { BaseComponentProps } from '../shared.ts';
+import type { BaseComponentProps } from '../shared.ts';
 /**
- * The props type for {@link !components.ProgressBar}.
+ * The props type for [ProgressBar](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/progress-bar).
  *
  * @category Component Props
  */

package/dist/shared/types/components/score.d.ts

@@ -1,6 +1,6 @@
-import { BaseComponentProps } from '../shared.ts';
+import type { BaseComponentProps } from '../shared.ts';
 /**
- * The props type for {@link !components.ScoreCircle}.
+ * The props type for [ScoreCircle](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/scorecircle)
  *
  * @category Component Props
  */

package/dist/shared/types/components/selects.d.ts

@@ -1,4 +1,4 @@
-import { BaseComponentProps } from '../shared.ts';
+import type { BaseComponentProps } from '../shared.ts';
 /**
  * Generic collection of props for select components
  * @internal
@@ -57,7 +57,7 @@ export interface BaseSelectProps extends BaseComponentProps {
     variant?: 'transparent' | 'input';
 }
 /**
- * The props type for {@link !components.Select}.
+ * The props type for [Select](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/select).
  *
  * @category Component Props
  */
@@ -95,7 +95,7 @@ export interface SelectProps extends BaseSelectProps {
     }[];
 }
 /**
- * The props type for {@link !components.MultiSelect}.
+ * The props type for [MultiSelect](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/multi-select).
  *
  * @category Component Props
  */

package/dist/shared/types/components/spacer.d.ts

@@ -0,0 +1,14 @@
+import type { AllSizesUnaliased, BaseComponentProps } from '../shared.ts';
+/**
+ * The props type for [Spacer](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/spacer)
+ *
+ * @category Component Props
+ */
+export interface SpacerProps extends BaseComponentProps {
+    /**
+     * The amount of vertical space to render.
+     *
+     * @defaultValue `"small"`
+     */
+    size?: AllSizesUnaliased;
+}

package/dist/shared/types/components/spacer.js

@@ -0,0 +1 @@
+export {};

package/dist/shared/types/components/statistics.d.ts

@@ -1,7 +1,7 @@
-import { ReactNode } from 'react';
-import { BaseComponentProps } from '../shared.ts';
+import type { ReactNode } from 'react';
+import type { BaseComponentProps } from '../shared.ts';
 /**
- * The props type for {@link !components.StatisticsTrend}.
+ * The props type for [StatisticsTrend](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/statistics).
  *
  * @category Component Props
  */
@@ -22,7 +22,7 @@ export interface StatisticsTrendProps extends BaseComponentProps {
     color?: 'red' | 'green';
 }
 /**
- * The props type for {@link !components.StatisticsItem}.
+ * The props type for [StatisticsItem](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/statistics).
  *
  * @category Component Props
  */
@@ -40,18 +40,18 @@ export interface StatisticsItemProps extends BaseComponentProps {
      */
     number: string | number;
     /**
-     * Sets the content that will render inside the component. This prop is passed implicitly by providing sub-components. The children should be {@link !components.StatisticsTrend} or {@link !components.Text}.
+     * Sets the content that will render inside the component. This prop is passed implicitly by providing sub-components. The children should be [StatisticsTrend](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/statistics) or [Text](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/text).
      */
     children?: ReactNode;
 }
 /**
- * The props type for {@link !components.Statistics}.
+ * The props type for [Statistics](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/statistics).
  *
  * @category Component Props
  */
 export interface StatisticsProps extends BaseComponentProps {
     /**
-     * Sets the content that will render inside the component. This prop is passed implicitly by providing sub-components. The children should be {@link !components.StatisticsItem}.
+     * Sets the content that will render inside the component. This prop is passed implicitly by providing sub-components. The children should be [StatisticsItem](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/statistics).
      */
     children: ReactNode;
 }

package/dist/shared/types/components/status-tag.d.ts

@@ -1,7 +1,7 @@
-import { ReactNode } from 'react';
-import { BaseComponentProps } from '../shared.ts';
+import type { ReactNode } from 'react';
+import type { BaseComponentProps } from '../shared.ts';
 /**
- * The props type for {@link !components.StatusTag}.
+ * The props type for [StatusTag](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/status-tag).
  *
  * @category Component Props
  */

package/dist/shared/types/components/step-indicator.d.ts

@@ -1,6 +1,6 @@
-import { AllSizes, BaseComponentProps } from '../shared.ts';
+import type { AllSizes, BaseComponentProps } from '../shared.ts';
 /**
- * The props type for {@link !components.StepIndicator}.
+ * The props type for [StepIndicator](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/step-indicator).
  *
  * @category Component Props
  */

package/dist/shared/types/components/table.d.ts

@@ -1,5 +1,5 @@
-import { ReactNode } from 'react';
-import { BaseComponentProps } from '../shared.ts';
+import type { ReactNode } from 'react';
+import type { BaseComponentProps } from '../shared.ts';
 export interface AlignmentProps {
     /**
      * Sets the alignment of the table element.
@@ -32,7 +32,7 @@ export type TableCellProps = TableElementProps & AlignmentProps & WidthProps & {
     colSpan?: number;
 } & BaseComponentProps;
 /**
- * The props type for {@link !components.TableHeader} when sorted === never.
+ * The props type for [TableHeader](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/table) when sorted === never.
  *
  * @category Component Props
  */
@@ -40,7 +40,7 @@ export interface UnSortedTableHeaderProps extends BaseTableHeaderProps {
     sortDirection?: 'never';
 }
 /**
- * The props type for {@link !components.TableHeader} when sorted !== never.
+ * The props type for [TableHeader](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/table) when sorted !== never.
  *
  * @category Component Props
  */
@@ -65,7 +65,7 @@ export interface SortedTableHeaderProps extends BaseTableHeaderProps {
     disabled?: boolean;
 }
 /**
- * The props type for {@link !components.TableHeader}.
+ * The props type for [TableHeader](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/table).
  *
  * @category Component Props
  */
@@ -141,7 +141,7 @@ export interface TablePaginatedProps extends BaseTableProps {
     onPageChange: (pageNumber: number) => void;
 }
 /**
- * The props type for {@link !components.Table}.
+ * The props type for [Table](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/table).
  *
  * @category Component Props
  */

package/dist/shared/types/components/tabs.d.ts

@@ -1,5 +1,5 @@
-import { ReactNode } from 'react';
-import { BaseComponentProps } from '../shared.ts';
+import type { ReactNode } from 'react';
+import type { BaseComponentProps } from '../shared.ts';
 export interface TabsProps extends BaseComponentProps {
     /**
      * Sets the content that will render inside the component.

package/dist/shared/types/components/tag.d.ts

@@ -1,8 +1,8 @@
-import { ReactNode } from 'react';
-import { OverlayComponentProps, ExtensionEvent, BaseComponentProps } from '../shared.ts';
-import { ReactionsHandler } from '../reactions.ts';
+import type { ReactNode } from 'react';
+import type { ReactionsHandler } from '../reactions.ts';
+import type { BaseComponentProps, ExtensionEvent, OverlayComponentProps } from '../shared.ts';
 /**
- * The props type for {@link !components.Tag}.
+ * The props type for [Tag](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/tag).
  *
  * @category Component Props
  */
@@ -18,7 +18,8 @@ export interface TagProps extends OverlayComponentProps, BaseComponentProps {
      */
     variant?: 'default' | 'warning' | 'success' | 'error' | 'info';
     /**
-     * A function that will be invoked when the tag is clicked. The function receives no arguments and its return value is ignored.
+     * A function that will be invoked when the button is clicked. It receives an event object and a reactions object
+     * with methods to control overlays. Its return value is ignored.
      *
      * @event
      */

package/dist/shared/types/components/text.d.ts

@@ -1,5 +1,5 @@
-import { ReactNode } from 'react';
-import { BaseComponentProps } from '../shared.ts';
+import type { ReactNode } from 'react';
+import type { BaseComponentProps } from '../shared.ts';
 /**
  * @internal
  * Format options for text component.
@@ -41,7 +41,7 @@ export interface TruncateOptions {
     tooltipText?: string;
 }
 /**
- * The props type for {@link !components.Text}.
+ * The props type for [Text](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/text).
  *
  * @interface
  * @category Component Props

package/dist/shared/types/components/tile.d.ts

@@ -1,7 +1,7 @@
-import { ReactNode } from 'react';
-import { BaseComponentProps } from '../shared.ts';
+import type { ReactNode } from 'react';
+import type { BaseComponentProps } from '../shared.ts';
 /**
- * The props type for {@link !components.Tile}.
+ * The props type for [Tile](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/tile).
  *
  * @category Component Props
  */

package/dist/shared/types/components/toggle.d.ts

@@ -1,6 +1,6 @@
-import { TShirtSizes, BaseComponentProps } from '../shared.ts';
+import type { BaseComponentProps, TShirtSizes } from '../shared.ts';
 /**
- * The props type for {@link !components.Toggle}.
+ * The props type for [Toggle](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/toggle).
  *
  * @category Component Props
  */

package/dist/shared/types/components/toggleInputs.d.ts

@@ -1,6 +1,6 @@
-import { BaseComponentProps } from '../shared.ts';
+import type { BaseComponentProps } from '../shared.ts';
 /**
- * The props type for {@link !components.Checkbox}.
+ * The props type for [Checkbox](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/checkbox).
  *
  * @category Component Props
  */
@@ -61,7 +61,7 @@ export interface CheckboxProps extends BaseComponentProps {
     'aria-label'?: string;
 }
 /**
- * The props type for {@link !components.RadioButton}.
+ * The props type for [RadioButton](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/radio-button).
  * @category Component Props
  * @interface
  */
@@ -189,7 +189,7 @@ type DefaultToggleTypeProps = {
     toggleType?: never;
 } & CheckboxGroupProps;
 /**
- * The props type for {@link !components.ToggleGroup}.
+ * The props type for [ToggleGroup](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/toggle-group).
  *
  * @interface
  * @category Component Props

package/dist/shared/types/components/tooltip.d.ts

@@ -1,5 +1,5 @@
-import { ReactNode } from 'react';
-import { BaseComponentProps } from '../shared.ts';
+import type { ReactNode } from 'react';
+import type { BaseComponentProps } from '../shared.ts';
 export interface TooltipProps extends BaseComponentProps {
     /**
      * Sets the content to render on the screen, and serves as the trigger for the tooltip. This prop is passed implicitly by providing sub-components.