Angular10 getLocaleDateFormat() Function

In this article, we are going to see what is getLocaleDateFormat in Angular 10 and how to use it.

The getLocaleDateFormat is used to get the localized date-value formatting for the given locale.

Syntax:

getLocaleDateFormat(locale: string, width: FormatWidth): string

NgModule: Module used by getLocaleDateFormat is:

• CommonModule

Approach: 

• Create the angular app to be used
• In app.module.ts import LOCALE_ID because we need locale to be imported for using get getLocaleDateFormat.

import { LOCALE_ID, NgModule } from '@angular/core';

• In app.component.ts import getLocaleDateFormat and LOCALE_ID
• inject LOCALE_ID as a public variable.
• In app.component.html show the local variable using string interpolation
• serve the angular app using ng serve to see the output.

Parameters:

• locale: A string containing locale code with rules.
• width: The format type.

Return value:

• string: string of localized formatting strings.

Example 1:

app.module.ts

import { LOCALE_ID, NgModule }
        from '@angular/core';
import { BrowserModule }
        from '@angular/platform-browser';

import { AppRoutingModule }
        from './app-routing.module';
import { AppComponent }
        from './app.component';

@NgModule({
  declarations: [
    AppComponent
  ],
  imports: [
    BrowserModule,
    AppRoutingModule
  ],
  providers: [
      { provide: LOCALE_ID, useValue: 'en-GB' },
  ],
  bootstrap: [AppComponent]
})
export class AppModule { }

app.component.ts

import {FormStyle,
        getLocaleDateFormat,
        TranslationWidth,
        FormatWidth}
        from '@angular/common';

import {Component,
        Inject,OnInit,
        LOCALE_ID }
        from '@angular/core';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html'
})
export class AppComponent {
    for = getLocaleDateFormat(this.locale,
               FormatWidth.Short);
    constructor(
        @Inject(LOCALE_ID) public locale: string,){}
      }

app.component.html

<h1>
   GeeksforGeeks
</h1>
<p>Date format is: {{for}}</p>

Output:

Example 2:

app.module.ts

import { LOCALE_ID, NgModule }
        from '@angular/core';
import { BrowserModule }
        from '@angular/platform-browser';

import { AppRoutingModule }
        from './app-routing.module';
import { AppComponent }
        from './app.component';

@NgModule({
  declarations: [
    AppComponent
  ],
  imports: [
    BrowserModule,
    AppRoutingModule
  ],
  providers: [
      { provide: LOCALE_ID, useValue: 'en-GB' },
  ],
  bootstrap: [AppComponent]
})
export class AppModule { }

app.component.ts

import {FormStyle,
  getLocaleDateFormat,
  TranslationWidth,
  FormatWidth}
  from '@angular/common';

import {Component,
        Inject,
        LOCALE_ID }
        from '@angular/core';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html'
})
export class AppComponent {
    for = getLocaleDateFormat(this.locale,
            FormatWidth.Long);
    constructor(
        @Inject(LOCALE_ID) public locale: string,){}
      }

app.component.html

<h1>
   GeeksforGeeks
</h1>
<p>Date format is: {{for}}</p>

Output:

Reference: https://angular.io/api/common/getLocaleDateFormat