### File

`src/lib/table-row-actions/decorators.ts`

### Index

###### Properties

- Optional checkFunction
- Optional color
- Optional confirm
- Optional errorMessage
- Optional priority
- Optional refresh
- Optional successMessage
- Optional tooltip
- Optional type

### Properties

checkFunction
`checkFunction: `RowActionCheckFunction<Data>``
Type : `RowActionCheckFunction<Data>`
Optional

color
`color: `ThemePalette``
Type : `ThemePalette`
Optional
The color of the action button.

confirm
`confirm: `boolean``
Type : `boolean`
Optional
If true, the user will be asked to confirm the action before execution.

errorMessage
`errorMessage: `string``
Type : `string`
Optional
The error message that will be displayed if the action fails.

priority
`priority: `number``
Type : `number`
Optional
The priority of the action. If multiple action with the same type exists. The action with the highest priority will be used. To set the defaults for the directive.

refresh
`refresh: `boolean``
Type : `boolean`
Optional
If true, the table will be refreshed after the action is executed.

successMessage
`successMessage: `string``
Type : `string`
Optional
The success message that will be displayed if the action succeeds.

tooltip
`tooltip: `string``
Type : `string`
Optional
The tooltip of the action button.

type
`type: `string``
Type : `string`
Optional

    import { ThemePalette } from '@angular/material/core';
    import { setMetadata } from '@rxap/reflect-metadata';
    import { RowActionCheckFunction } from './types';

    /**
     * @deprecated use RXAP_TABLE_ACTION_METHOD_METADATA instead
     */
    export const RXAP_TABLE_ACTION_METHOD_TYPE_METADATA = 'rxap-table-action-method-type-metadata';
    export const RXAP_TABLE_ACTION_METHOD_METADATA = 'rxap-table-action-method-metadata';

    /**
     * @deprecated use RXAP_TABLE_ACTION_METHOD_METADATA instead
     */
    export const RXAP_TABLE_ACTION_METHOD_CHECK_FUNCTION_METADATA = 'rxap-table-action-method-check-function-metadata';

    export interface TableActionMethodOptions<Data = any> {
      type?: string;
      checkFunction?: RowActionCheckFunction<Data>;
      /**
       * If true, the table will be refreshed after the action is executed.
       */
      refresh?: boolean;
      /**
       * If true, the user will be asked to confirm the action before execution.
       */
      confirm?: boolean;
      /**
       * The tooltip of the action button.
       */
      tooltip?: string;

      /**
       * The error message that will be displayed if the action fails.
       */
      errorMessage?: string;

      /**
       * The success message that will be displayed if the action succeeds.
       */
      successMessage?: string;

      /**
       * The priority of the action. If multiple action with the same type exists.
       * The action with the highest priority will be used. To set the defaults for
       * the directive.
       */
      priority?: number;

      /**
       * The color of the action button.
       */
      color?: ThemePalette;
    }

    export function TableActionMethod<Data = any>(options: TableActionMethodOptions): ClassDecorator;
    export function TableActionMethod<Data = any>(
      type: string,
      checkFunction?: RowActionCheckFunction<Data>,
    ): ClassDecorator;
    export function TableActionMethod<Data = any>(
      typeOrOptions: string | TableActionMethodOptions,
      checkFunction?: RowActionCheckFunction<Data>,
    ): ClassDecorator {
      let type: string | undefined;
      let options: TableActionMethodOptions<Data>;
      if (typeof typeOrOptions === 'string') {
        type = typeOrOptions;
        options = {
          type,
          checkFunction,
        };
      } else {
        options = typeOrOptions;
        type = options.type;
        checkFunction = options.checkFunction;
      }
      return function (target: any) {
        setMetadata(RXAP_TABLE_ACTION_METHOD_METADATA, options, target);
        if (type) {
          setMetadata(RXAP_TABLE_ACTION_METHOD_TYPE_METADATA, type, target);
        }
        if (checkFunction) {
          setMetadata(RXAP_TABLE_ACTION_METHOD_CHECK_FUNCTION_METADATA, checkFunction, target);
        }
      };
    }

# results matching ""

# No results matching ""