← DataGrid API

Directive · v2.7.1

NgbGridBatchEditingDirective

Draft-only clipboard editing. Apply commits once; application code owns persistence.

Import

import { NgbGridBatchEditingDirective } from '@angular-bootstrap/ngbootstrap';

Selector:ngb-datagrid[ngbGridBatchEditing]

Declaration

class NgbGridBatchEditingDirective<T extends object = Record<string, unknown>> implements NgbGridBatchController

Inputs

batchValidator

batchValidator?: NgbGridBatchValidator<T>

Outputs

batchResult

batchResult: EventEmitter<NgbGridBatchResult>

Properties

pendingCount

readonly pendingCount: i0.Signal<number>

validating

readonly validating: i0.Signal<boolean>

errors

readonly errors: i0.Signal<readonly NgbGridBatchCellError[]>

message

readonly message: i0.Signal<string>

canApply

readonly canApply: i0.Signal<boolean>

Methods

hasPending

hasPending(): boolean

value

value(rowId: unknown, field: string, fallback: unknown): unknown

dirty

dirty(rowId: unknown, field: string): boolean

error

error(rowId: unknown, field: string): string

onGridChange

onGridChange(): void

copySelection

copySelection(): NgbGridClipboardResult

stagePaste

stagePaste(text: string): NgbGridBatchResult

applyBatch

applyBatch(): Promise<NgbGridBatchResult>

restoreBatch

Internal history bridge. Replay uses the same validation and atomic commit path.

restoreBatch(changes: NgbGridBatchRowChange<unknown>[], action: 'undo' | 'redo'): Promise<NgbGridBatchResult>

discardBatch

discardBatch(): void

onCopy

onCopy(event: ClipboardEvent): void

onPaste

onPaste(event: ClipboardEvent): void

Referenced types

Source: src/datagrid/src/batch/datagrid-batch.directive.ts in the installed @angular-bootstrap/ngbootstrap package. Angular compiler metadata and private members are omitted.

This project is not affiliated with ng-bootstrap or ngx-bootstrap. Those projects focus mainly on Bootstrap components for Angular. ngbootstrap focuses on Angular UI for data-heavy apps, especially Data Grid, Angular-native Form Builder, drag and drop workflows, documentation examples, and performance-focused Angular patterns.