Angular10 getLocaleDayPeriods() Function

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

The getLocaleDayPeriods used to get the day period strings for the given locale.

Syntax:

getLocaleDayPeriods(locale: string, 
                    formStyle: FormStyle, 
                    width: TranslationWidth)

NgModule: Module used by getLocaleDayPeriods 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 getLocaleDayPeriods.

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

• In app.component.ts import getLocaleDayPeriods 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 character width.
• formStyle: The form style.

Return value:

• array: array of localized period 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,
        getLocaleDayPeriods,
        TranslationWidth }
        from '@angular/common';

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

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html'
})
export class AppComponent {
    dir = getLocaleDayPeriods(this.locale,
                        FormStyle.Standalone,
                        TranslationWidth.Wide);
    constructor(
        @Inject(LOCALE_ID) public locale: string,){}
      }

app.component.html

<h1>
   GeeksforGeeks
</h1>
 <p>Locale Time is : {{dir}}</p>

Output:

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