@aragon/gov-ui-kit 1.23.1 → 1.25.0

package/dist/types/src/core/components/accordion/accordionItemHeader/accordionItemHeader.api.d.ts

@@ -0,0 +1,25 @@
+import type { ComponentPropsWithRef } from 'react';
+export interface IAccordionItemHeaderRemoveControl {
+    /**
+     * Label of the remove control.
+     */
+    label: string;
+    /**
+     * Callback called with the current item and its index on remove button click.
+     */
+    onClick: (index: number) => void;
+    /**
+     * Whether the remove control is disabled.
+     */
+    disabled: boolean;
+}
+export interface IAccordionItemHeaderProps extends ComponentPropsWithRef<'button'> {
+    /**
+     * Remove control to be displayed in edit mode.
+     */
+    removeControl?: IAccordionItemHeaderRemoveControl;
+    /**
+     * The index of the accordion item.
+     */
+    index?: number;
+}

package/dist/types/src/core/components/accordion/accordionItemHeader/accordionItemHeader.d.ts

@@ -1,4 +1,2 @@
-import { type ComponentPropsWithRef } from 'react';
-export interface IAccordionItemHeaderProps extends ComponentPropsWithRef<'button'> {
-}
+import type { IAccordionItemHeaderProps } from './accordionItemHeader.api';
 export declare const AccordionItemHeader: import("react").ForwardRefExoticComponent<Omit<IAccordionItemHeaderProps, "ref"> & import("react").RefAttributes<HTMLButtonElement>>;

package/dist/types/src/core/components/accordion/accordionItemHeader/index.d.ts

@@ -1 +1,2 @@
-export { AccordionItemHeader, type IAccordionItemHeaderProps } from './accordionItemHeader';
+export { AccordionItemHeader } from './accordionItemHeader';
+export type { IAccordionItemHeaderProps, IAccordionItemHeaderRemoveControl } from './accordionItemHeader.api';

package/dist/types/src/modules/assets/copy/modulesCopy.d.ts

@@ -44,6 +44,7 @@ export declare const modulesCopy: {
         dropdownLabel: string;
         nativeSendAlert: string;
         nativeSendDescription: (amount: string, symbol: string) => string;
+        of: string;
         menu: {
             BASIC: string;
             dropdownLabel: string;
@@ -54,6 +55,7 @@ export declare const modulesCopy: {
     proposalActionsDecoder: {
         copyData: string;
         add: string;
+        noParametersMessage: string;
         validation: {
             required: (label: string) => string;
             boolean: (label: string) => string;

package/dist/types/src/modules/components/proposal/proposalActions/proposalActionsContext/proposalActionsContext.d.ts

@@ -19,6 +19,10 @@ export interface IProposalActionsContext {
      * Whether or not the list of actions is loading.
      */
     isLoading: boolean;
+    /**
+     * Whether or not the component is in edit mode.
+     */
+    editMode: boolean;
 }
 export declare const proposalActionsContext: import("react").Context<IProposalActionsContext | null>;
 export declare const ProposalActionsContextProvider: import("react").Provider<IProposalActionsContext | null>;

package/dist/types/src/modules/components/proposal/proposalActions/proposalActionsItem/index.d.ts

@@ -1,2 +1,2 @@
 export { ProposalActionsItem } from './proposalActionsItem';
-export type { IProposalActionsItemDropdownItem, IProposalActionsItemProps, ProposalActionsItemViewMode, } from './proposalActionsItem.api';
+export type { IProposalActionsArrayControl, IProposalActionsArrayControls, IProposalActionsItemProps, ProposalActionsItemViewMode, } from './proposalActionsItem.api';

package/dist/types/src/modules/components/proposal/proposalActions/proposalActionsItem/proposalActionsItem.api.d.ts

@@ -1,21 +1,34 @@
-import type { IconType } from '../../../../../core';
 import type { IWeb3ComponentProps } from '../../../../types';
 import type { ProposalActionsDecoderView } from '../proposalActionsDecoder';
 import type { IProposalAction, ProposalActionComponent } from '../proposalActionsDefinitions';
 export type ProposalActionsItemViewMode = 'BASIC' | ProposalActionsDecoderView;
-export interface IProposalActionsItemDropdownItem<TAction extends IProposalAction = IProposalAction> {
+export interface IProposalActionsArrayControl<TAction extends IProposalAction = IProposalAction> {
     /**
      * Label of the item.
      */
     label: string;
     /**
-     * Icon of the item.
+     * Callback called with the current action and its index on item click.
      */
-    icon: IconType;
+    onClick: (index: number, action?: TAction) => void;
     /**
-     * Callback called with the current action and its index on item click.
+     * Whether the item is disabled.
      */
-    onClick: (action: TAction, index: number) => void;
+    disabled: boolean;
+}
+export interface IProposalActionsArrayControls<TAction extends IProposalAction = IProposalAction> {
+    /**
+     * Move down control.
+     */
+    moveDown: IProposalActionsArrayControl<TAction>;
+    /**
+     * Move up control.
+     */
+    moveUp: IProposalActionsArrayControl<TAction>;
+    /**
+     * Remove control.
+     */
+    remove: IProposalActionsArrayControl<TAction>;
 }
 export interface IProposalActionsItemProps<TAction extends IProposalAction = IProposalAction> extends IWeb3ComponentProps {
     /**
@@ -26,6 +39,10 @@ export interface IProposalActionsItemProps<TAction extends IProposalAction = IPr
      * Function selector of the action to be displayed optionally.
      */
     actionFunctionSelector?: string;
+    /**
+     * Count of the action to be displayed optionally.
+     */
+    actionCount?: number;
     /**
      * Index of the action injected by the <ProposalActions.Container /> component.
      */
@@ -39,9 +56,9 @@ export interface IProposalActionsItemProps<TAction extends IProposalAction = IPr
      */
     CustomComponent?: ProposalActionComponent<TAction>;
     /**
-     * Items displayed beside the "View as" menu.
+     * Controls for the action to be moved up or down.
      */
-    dropdownItems?: Array<IProposalActionsItemDropdownItem<TAction>>;
+    arrayControls?: IProposalActionsArrayControls<TAction>;
     /**
      * Enables the edit-mode when set to true. The RAW view will be editable only if the action has no DECODED view,
      * similarly the DECODED view will be editable only if the action has no BASIC view.
@@ -53,4 +70,9 @@ export interface IProposalActionsItemProps<TAction extends IProposalAction = IPr
      * Form prefix to be prepended to all proposal action text fields.
      */
     formPrefix?: string;
+    /**
+     * Chain ID for the blockchain network.
+     * @default mainnet.id
+     */
+    chainId?: number;
 }

package/dist/types/src/modules/components/proposal/proposalActions/proposalActionsRoot/proposalActionsRoot.d.ts

@@ -9,6 +9,7 @@ export interface IProposalActionsRootProps extends ComponentProps<'div'> {
     actionsCount?: number;
     /**
      * List of actions ids that are expanded. To be used for controlling the expanded / collapsed states.
+     * When using editMode, you should set this prop to expand all actions (e.g., array of all action indices as strings).
      */
     expandedActions?: string[];
     /**
@@ -20,5 +21,12 @@ export interface IProposalActionsRootProps extends ComponentProps<'div'> {
      * @default false
      */
     isLoading?: boolean;
+    /**
+     * Whether or not the component is in edit mode. When true, actions show index badges, movement controls,
+     * and remove buttons. Note: This prop controls UI features only - you must also set expandedActions to
+     * expand the accordions.
+     * @default false
+     */
+    editMode?: boolean;
 }
 export declare const ProposalActionsRoot: React.FC<IProposalActionsRootProps>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aragon/gov-ui-kit",
-  "version": "1.23.1",
+  "version": "1.25.0",
   "description": "Implementation of the Aragon's Governance UI Kit",
   "main": "dist/index.es.js",
   "types": "dist/types/src/index.d.ts",