docs(timepicker): add note on text localization config

akveo · Jun 15, 2021 · fd01cef · fd01cef
1 parent 456b165
commit fd01cef
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/src/framework/theme/components/timepicker/timepicker.directive.ts b/src/framework/theme/components/timepicker/timepicker.directive.ts
@@ -116,6 +116,25 @@ import { NB_DOCUMENT } from '../../theme.options';
  * <input [nbTimepicker]="timepicker" twelveHoursFormat>
  * <nb-timepicker #timepicke [ngModel]="date"></nb-timepicker>
  *
+ * You can provide localized versions of the timepicker text via the `localization` property of the config
+ * object passed to the `forRoot` or `forChild` methods of the `NbTimepickerModule`:
+ * ```ts
+ * @NgModule({
+ *   imports: [
+ *     // ...
+ *     NbTimepickerModule.forRoot({
+ *       localization: {
+ *         hoursText: 'Hr',
+ *         minutesText: 'Min',
+ *         secondsText: 'Sec',
+ *         ampmText: 'Am/Pm',
+ *       }
+ *     }),
+ *   ],
+ * })
+ * export class AppModule { }
+ * ```
+ *
  * @styles
  *
  * timepicker-cell-text-color: