AI Translation Utils

Utility functions for AI translation services, including AG Grid column feature state management.

Installation

yarn add @procore/ai-translation-utils

Peer Dependencies

This package requires the following peer dependencies:

• @ag-grid-community/core >= 31

Usage

Column Feature State Management

Utilities for managing translation and highlight states on AG Grid columns.

import {
  isColumnTranslationEnabled,
  toggleColumnTranslation,
  isColumnHighlightEnabled,
  toggleColumnHighlight,
  clearColumnFeatureStates,
} from '@procore/ai-translation-utils';

Toggle Translation on a Column

// Check if translation is enabled for a column
const isEnabled = isColumnTranslationEnabled(gridApi, 'description');

// Toggle translation on/off for a column
toggleColumnTranslation(gridApi, 'description');

Toggle Highlighting on a Column

// Check if highlighting is enabled for a column
const isHighlighted = isColumnHighlightEnabled(gridApi, 'description');

// Toggle highlighting on/off for a column
toggleColumnHighlight(gridApi, 'description');

Clear All States (e.g., on Pagination)

// Clear all translation and highlight states
gridApi.addEventListener('paginationChanged', () => {
  clearColumnFeatureStates(gridApi);
});

API Reference

isColumnTranslationEnabled(gridApi, field)

Checks if translation is enabled for a specific column.

• Parameters:
  • gridApi: GridApi | null | undefined - The AG Grid API instance
  • field: string | undefined - The column field identifier
• Returns: boolean - True if translation is enabled

toggleColumnTranslation(gridApi, field)

Toggles the translation state for a specific column and refreshes the cells.

• Parameters:
  • gridApi: GridApi | null | undefined - The AG Grid API instance
  • field: string | undefined - The column field identifier

isColumnHighlightEnabled(gridApi, field)

Checks if highlighting is enabled for a specific column.

• Parameters:
  • gridApi: GridApi | null | undefined - The AG Grid API instance
  • field: string | undefined - The column field identifier
• Returns: boolean - True if highlighting is enabled

toggleColumnHighlight(gridApi, field)

Toggles the highlight state for a specific column and refreshes the cells.

• Parameters:
  • gridApi: GridApi | null | undefined - The AG Grid API instance
  • field: string | undefined - The column field identifier

clearColumnFeatureStates(gridApi)

Clears all column feature states (translation and highlight) for a grid.

• Parameters:
  • gridApi: GridApi | null | undefined - The AG Grid API instance

Development

Build

yarn build

Test

yarn test

Lint

yarn lint

Format

yarn format