angular/packages/forms/src/directives/validators.ts at main · angular/angular · GitHub

Repository navigation

History

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

/**

* @license

* Use of this source code is governed by an MIT-style license that can be

* found in the LICENSE file at https://angular.dev/license

import {

booleanAttribute,

Directive,

forwardRef,

Input,

OnChanges,

Provider,

SimpleChanges,

} from '@angular/core';

import {Observable} from 'rxjs';

import type {AbstractControl} from '../model/abstract_model';

import {

emailValidator,

maxLengthValidator,

maxValidator,

minLengthValidator,

minValidator,

NG_VALIDATORS,

nullValidator,

patternValidator,

requiredTrueValidator,

requiredValidator,

} from '../validators';

/**

* Method that updates string to integer if not already a number

* @param value The value to convert to integer.

* @returns value of parameter converted to number or integer.

function toInteger(value: string | number): number {

return typeof value === 'number' ? value : parseInt(value, 10);

}

/**

* Method that ensures that provided value is a float (and converts it to float if needed).

* @param value The value to convert to float.

* @returns value of parameter converted to number or float.

function toFloat(value: string | number): number {

return typeof value === 'number' ? value : parseFloat(value);

}

/**

* @description

* Defines the map of errors returned from failed validation checks.

* @see [Defining custom validators](guide/forms/form-validation#defining-custom-validators)

* @publicApi

export type ValidationErrors = {

[key: string]: any;

};

/**

* @description

* An interface implemented by classes that perform synchronous validation.

* @usageNotes

* ### Provide a custom validator

* The following example implements the `Validator` interface to create a

* validator directive with a custom error key.

* ```ts

* @Directive({

* selector: '[customValidator]',

* providers: [{provide: NG_VALIDATORS, useExisting: forwardRef(() => CustomValidatorDirective), multi: true}]

* })

* class CustomValidatorDirective implements Validator {

* validate(control: AbstractControl): ValidationErrors|null {

* return {'custom': true};

* }

* ```

* @publicApi

export interface Validator {

/**

* @description

* Method that performs synchronous validation against the provided control.

* @param control The control to validate against.

* @returns A map of validation errors if validation fails,

* otherwise null.

validate(control: AbstractControl): ValidationErrors | null;

/**

* @description

* Registers a callback function to call when the validator inputs change.

* @param fn The callback function

registerOnValidatorChange?(fn: () => void): void;

}

/**

* A base class for Validator-based Directives. The class contains common logic shared across such

* Directives.

* For internal use only, this class is not intended for use outside of the Forms package.

@Directive()

abstract class AbstractValidatorDirective implements Validator, OnChanges {

private _validator: ValidatorFn = nullValidator;

private _onChange!: () => void;

/**

* A flag that tracks whether this validator is enabled.

* Marking it `internal` (vs `protected`), so that this flag can be used in host bindings of

* directive classes that extend this base class.

* @internal

_enabled?: boolean;

/**

* Name of an input that matches directive selector attribute (e.g. `minlength` for

* `MinLengthDirective`). An input with a given name might contain configuration information (like

* `minlength='10'`) or a flag that indicates whether validator should be enabled (like

* `[required]='false'`).

* @internal

abstract inputName: string;

/**

* Creates an instance of a validator (specific to a directive that extends this base class).

* @internal

abstract createValidator(input: unknown): ValidatorFn;

/**

* Performs the necessary input normalization based on a specific logic of a Directive.

* For example, the function might be used to convert string-based representation of the

* `minlength` input to an integer value that can later be used in the `Validators.minLength`

* validator.

* @internal

abstract normalizeInput(input: unknown): unknown;

/** @docs-private */

ngOnChanges(changes: SimpleChanges): void {

if (this.inputName in changes) {

const input = this.normalizeInput(changes[this.inputName].currentValue);

this._enabled = this.enabled(input);

this._validator = this._enabled ? this.createValidator(input) : nullValidator;

this._onChange?.();

}

/** @docs-private */

validate(control: AbstractControl): ValidationErrors | null {

return this._validator(control);

}

/** @docs-private */

registerOnValidatorChange(fn: () => void): void {

this._onChange = fn;

}

/**

* @description

* Determines whether this validator should be active or not based on an input.

* Base class implementation checks whether an input is defined (if the value is different from

* `null` and `undefined`). Validator classes that extend this base class can override this

* function with the logic specific to a particular validator directive.

enabled(input: unknown): boolean {

return input != null /* both `null` and `undefined` */;

}

/**

* @description

* Provider which adds `MaxValidator` to the `NG_VALIDATORS` multi-provider list.

export const MAX_VALIDATOR: Provider = {

provide: NG_VALIDATORS,

useExisting: forwardRef(() => MaxValidator),

multi: true,

};

/**

* A directive which installs the {@link MaxValidator} for any `formControlName`,

* `formControl`, or control with `ngModel` that also has a `max` attribute.

* @see [Form Validation](guide/forms/form-validation)

* @usageNotes

* ### Adding a max validator

* The following example shows how to add a max validator to an input attached to an

* ngModel binding.

* ```html

* <input type="number" ngModel max="4">

* ```

* @ngModule ReactiveFormsModule

* @ngModule FormsModule

* @publicApi

@Directive({

selector:

'input[type=number][max][formControlName],input[type=number][max][formControl],input[type=number][max][ngModel]',

providers: [MAX_VALIDATOR],

host: {'[attr.max]': '_enabled ? max : null'},

standalone: false,

})

export class MaxValidator extends AbstractValidatorDirective {

/**

* @description

* Tracks changes to the max bound to this directive.

@Input() max!: string | number | null;

/** @internal */

override inputName = 'max';

/** @internal */

override normalizeInput = (input: string | number): number => toFloat(input);

/** @internal */

override createValidator = (max: number): ValidatorFn => maxValidator(max);

}

/**

* @description

* Provider which adds `MinValidator` to the `NG_VALIDATORS` multi-provider list.

export const MIN_VALIDATOR: Provider = {

provide: NG_VALIDATORS,

useExisting: forwardRef(() => MinValidator),

multi: true,

};

/**

* A directive which installs the {@link MinValidator} for any `formControlName`,

* `formControl`, or control with `ngModel` that also has a `min` attribute.

* @see [Form Validation](guide/forms/form-validation)

* @usageNotes

* ### Adding a min validator

* The following example shows how to add a min validator to an input attached to an

* ngModel binding.

* ```html

* <input type="number" ngModel min="4">

* ```

* @ngModule ReactiveFormsModule

* @ngModule FormsModule

* @publicApi

@Directive({

selector:

'input[type=number][min][formControlName],input[type=number][min][formControl],input[type=number][min][ngModel]',

providers: [MIN_VALIDATOR],

host: {'[attr.min]': '_enabled ? min : null'},

standalone: false,

})

export class MinValidator extends AbstractValidatorDirective {

/**

* @description

* Tracks changes to the min bound to this directive.

@Input() min!: string | number | null;

/** @internal */

override inputName = 'min';

/** @internal */

override normalizeInput = (input: string | number): number => toFloat(input);

/** @internal */

override createValidator = (min: number): ValidatorFn => minValidator(min);

}

/**

* @description

* An interface implemented by classes that perform asynchronous validation.

* @usageNotes

* ### Provide a custom async validator directive

* The following example implements the `AsyncValidator` interface to create an

* async validator directive with a custom error key.

* ```ts

* import { of } from 'rxjs';

* @Directive({

* selector: '[customAsyncValidator]',

* providers: [{provide: NG_ASYNC_VALIDATORS, useExisting: CustomAsyncValidatorDirective, multi:

* true}]

* })

* class CustomAsyncValidatorDirective implements AsyncValidator {

* validate(control: AbstractControl): Observable<ValidationErrors|null> {

* return of({'custom': true});

* }

* ```

* @see [Creating asynchronous validators](guide/forms/form-validation#creating-asynchronous-validators)

* @publicApi

export interface AsyncValidator extends Validator {

/**

* @description

* Method that performs async validation against the provided control.

* @param control The control to validate against.

* @returns A promise or observable that resolves a map of validation errors

* if validation fails, otherwise null.

validate(

control: AbstractControl,

): Promise<ValidationErrors | null> | Observable<ValidationErrors | null>;

}

/**

* @description

* Provider which adds `RequiredValidator` to the `NG_VALIDATORS` multi-provider list.

export const REQUIRED_VALIDATOR: Provider = {

provide: NG_VALIDATORS,

useExisting: forwardRef(() => RequiredValidator),

multi: true,

};

/**

* @description

* Provider which adds `CheckboxRequiredValidator` to the `NG_VALIDATORS` multi-provider list.

export const CHECKBOX_REQUIRED_VALIDATOR: Provider = {

provide: NG_VALIDATORS,

useExisting: forwardRef(() => CheckboxRequiredValidator),

multi: true,

};

/**

* @description

* A directive that adds the `required` validator to any controls marked with the

* `required` attribute. The directive is provided with the `NG_VALIDATORS` multi-provider list.

* @see [Form Validation](guide/forms/form-validation)

* @usageNotes

* ### Adding a required validator using template-driven forms

* ```html

* <input name="fullName" ngModel required>

* ```

* @ngModule FormsModule

* @ngModule ReactiveFormsModule

* @publicApi

@Directive({

selector:

':not([type=checkbox])[required][formControlName],:not([type=checkbox])[required][formControl],:not([type=checkbox])[required][ngModel]',

providers: [REQUIRED_VALIDATOR],

host: {'[attr.required]': '_enabled ? "" : null'},

standalone: false,

})

export class RequiredValidator extends AbstractValidatorDirective {

/**

* @description

* Tracks changes to the required attribute bound to this directive.

@Input() required!: boolean | string;

/** @internal */

override inputName = 'required';

/** @internal */

override normalizeInput = booleanAttribute;

/** @internal */

override createValidator = (input: boolean): ValidatorFn => requiredValidator;

/** @docs-private */

override enabled(input: boolean): boolean {

return input;

}

/**

* A Directive that adds the `required` validator to checkbox controls marked with the

* `required` attribute. The directive is provided with the `NG_VALIDATORS` multi-provider list.

* @see [Form Validation](guide/forms/form-validation)

* @usageNotes

* ### Adding a required checkbox validator using template-driven forms

* The following example shows how to add a checkbox required validator to an input attached to an

* ngModel binding.

* ```html

* <input type="checkbox" name="active" ngModel required>

* ```

* @publicApi

* @ngModule FormsModule

* @ngModule ReactiveFormsModule

@Directive({

selector:

'input[type=checkbox][required][formControlName],input[type=checkbox][required][formControl],input[type=checkbox][required][ngModel]',

providers: [CHECKBOX_REQUIRED_VALIDATOR],

host: {'[attr.required]': '_enabled ? "" : null'},

standalone: false,

})

export class CheckboxRequiredValidator extends RequiredValidator {

/** @internal */

override createValidator = (input: unknown): ValidatorFn => requiredTrueValidator;

}

/**

* @description

* Provider which adds `EmailValidator` to the `NG_VALIDATORS` multi-provider list.

export const EMAIL_VALIDATOR: any = {

provide: NG_VALIDATORS,

useExisting: forwardRef(() => EmailValidator),

multi: true,

};

/**

* A directive that adds the `email` validator to controls marked with the

* `email` attribute. The directive is provided with the `NG_VALIDATORS` multi-provider list.

* The email validation is based on the WHATWG HTML specification with some enhancements to

* incorporate more RFC rules. More information can be found on the [Validators.email

* page](api/forms/Validators#email).

* @see [Form Validation](guide/forms/form-validation)

* @usageNotes

* ### Adding an email validator

* The following example shows how to add an email validator to an input attached to an ngModel

* binding.

* ```html

* <input type="email" name="email" ngModel email>

* <input type="email" name="email" ngModel email="true">

* <input type="email" name="email" ngModel [email]="true">

* ```

* @publicApi

* @ngModule FormsModule

* @ngModule ReactiveFormsModule

@Directive({

selector: '[email][formControlName],[email][formControl],[email][ngModel]',

providers: [EMAIL_VALIDATOR],

standalone: false,

})

export class EmailValidator extends AbstractValidatorDirective {

/**

* @description

* Tracks changes to the email attribute bound to this directive.

@Input() email!: boolean | string;

/** @internal */

override inputName = 'email';

/** @internal */

override normalizeInput = booleanAttribute;

/** @internal */

override createValidator = (input: number): ValidatorFn => emailValidator;

/** @docs-private */

override enabled(input: boolean): boolean {

return input;

}

/**

* @description

* A function that receives a control and synchronously returns a map of

* validation errors if present, otherwise null.

* @see [Defining custom validators](guide/forms/form-validation#defining-custom-validators)

* @publicApi

export interface ValidatorFn {

(control: AbstractControl): ValidationErrors | null;

}

/**

* @description

* A function that receives a control and returns a Promise or observable

* that emits validation errors if present, otherwise null.

* @see [Creating asynchronous validators](guide/forms/form-validation#creating-asynchronous-validators)

* @publicApi

export interface AsyncValidatorFn {

(

control: AbstractControl,

): Promise<ValidationErrors | null> | Observable<ValidationErrors | null>;

}

/**

* @description

* Provider which adds `MinLengthValidator` to the `NG_VALIDATORS` multi-provider list.

export const MIN_LENGTH_VALIDATOR: any = {

provide: NG_VALIDATORS,

useExisting: forwardRef(() => MinLengthValidator),

multi: true,

};

/**

* A directive that adds minimum length validation to controls marked with the

* `minlength` attribute. The directive is provided with the `NG_VALIDATORS` multi-provider list.

* @see [Form Validation](guide/forms/form-validation)

* @usageNotes

* ### Adding a minimum length validator

* The following example shows how to add a minimum length validator to an input attached to an

* ngModel binding.

* ```html

* <input name="firstName" ngModel minlength="4">

* ```

* @ngModule ReactiveFormsModule

* @ngModule FormsModule

* @publicApi

@Directive({

selector: '[minlength][formControlName],[minlength][formControl],[minlength][ngModel]',

providers: [MIN_LENGTH_VALIDATOR],

host: {'[attr.minlength]': '_enabled ? minlength : null'},

standalone: false,

})

export class MinLengthValidator extends AbstractValidatorDirective {

/**

* @description

* Tracks changes to the minimum length bound to this directive.

@Input() minlength!: string | number | null;

/** @internal */

override inputName = 'minlength';

/** @internal */

override normalizeInput = (input: string | number): number => toInteger(input);

/** @internal */

override createValidator = (minlength: number): ValidatorFn => minLengthValidator(minlength);

}

/**

* @description

* Provider which adds `MaxLengthValidator` to the `NG_VALIDATORS` multi-provider list.

export const MAX_LENGTH_VALIDATOR: any = {

provide: NG_VALIDATORS,

useExisting: forwardRef(() => MaxLengthValidator),

multi: true,

};

/**

* A directive that adds maximum length validation to controls marked with the

* `maxlength` attribute. The directive is provided with the `NG_VALIDATORS` multi-provider list.

* @see [Form Validation](guide/forms/form-validation)

* @usageNotes

* ### Adding a maximum length validator

* The following example shows how to add a maximum length validator to an input attached to an

* ngModel binding.

* ```html

* <input name="firstName" ngModel maxlength="25">

* ```

* @ngModule ReactiveFormsModule

* @ngModule FormsModule

* @publicApi

@Directive({

selector: '[maxlength][formControlName],[maxlength][formControl],[maxlength][ngModel]',

providers: [MAX_LENGTH_VALIDATOR],

host: {'[attr.maxlength]': '_enabled ? maxlength : null'},

standalone: false,

})

export class MaxLengthValidator extends AbstractValidatorDirective {

/**

* @description

* Tracks changes to the maximum length bound to this directive.

@Input() maxlength!: string | number | null;

/** @internal */

override inputName = 'maxlength';

/** @internal */

override normalizeInput = (input: string | number): number => toInteger(input);

/** @internal */

override createValidator = (maxlength: number): ValidatorFn => maxLengthValidator(maxlength);

}

/**

* @description

* Provider which adds `PatternValidator` to the `NG_VALIDATORS` multi-provider list.

export const PATTERN_VALIDATOR: any = {

provide: NG_VALIDATORS,

useExisting: forwardRef(() => PatternValidator),

multi: true,

};

/**

* @description

* A directive that adds regex pattern validation to controls marked with the

* `pattern` attribute. The regex must match the entire control value.

* The directive is provided with the `NG_VALIDATORS` multi-provider list.

* @see [Form Validation](guide/forms/form-validation)

* @usageNotes

* ### Adding a pattern validator

* The following example shows how to add a pattern validator to an input attached to an

* ngModel binding.

* ```html

* <input name="firstName" ngModel pattern="[a-zA-Z ]*">

* ```

* @ngModule ReactiveFormsModule

* @ngModule FormsModule

* @publicApi

@Directive({

selector: '[pattern][formControlName],[pattern][formControl],[pattern][ngModel]',

providers: [PATTERN_VALIDATOR],

host: {'[attr.pattern]': '_enabled ? pattern : null'},

standalone: false,

})

export class PatternValidator extends AbstractValidatorDirective {

/**

* @description

* Tracks changes to the pattern bound to this directive.

@Input()

pattern!: string | RegExp; // This input is always defined, since the name matches selector.

/** @internal */

override inputName = 'pattern';

/** @internal */

override normalizeInput = (input: string | RegExp): string | RegExp => input;

/** @internal */

override createValidator = (input: string | RegExp): ValidatorFn => patternValidator(input);

}

angular/packages/forms/src/directives/validators.ts at main · angular/angular · GitHub

Repository navigation

Expand file tree

Breadcrumbs

validators.ts

Latest commit

History

Breadcrumbs

validators.ts

File metadata and controls