Skip to content

docs(localization): Update localiation topic with new functionality and mark old one as legacy.#6236

Merged
dkamburov merged 19 commits intovnextfrom
skrastev/localization
Feb 5, 2026
Merged

docs(localization): Update localiation topic with new functionality and mark old one as legacy.#6236
dkamburov merged 19 commits intovnextfrom
skrastev/localization

Conversation

@skrustev
Copy link
Copy Markdown
Member

@skrustev skrustev commented Oct 14, 2025

Requires IgniteUI/igniteui-angular-samples#3752

Checklist:

  • check topic's TOC/menu and paragraph headings
  • Include TOC topic labels in topic content has a valuable update, it's new or considered as preview\ beta
  • link to other topics using ../relative/path.md
  • at the References section at the end of the topic add links to topics, samples, etc
  • reference API documentation instead of adding a section with API

  • use valid component names - [Data] Grid, IgxSelectComponent, <igx-combo>
  • use spell checker tool (VS Code, Grammarly, Microsoft Editor)
  • add inline code blocks for the names of classes / tags / properties
  • add language descriptor for the code blocks
  • check broken links (use browser add-on)
  • check if sample is working and fully visible in the topic
  • check if sample is working and fully visible in the StackBlitz
  • check if code blocks match the code in StackBlitz demo


  • do not resolve requested changes (leave that to the reviewer)
  • add pending-localization label when the review of the PR is done
  • add a member from the localization team to translate it

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the localization documentation to introduce a new recommended localization approach (as of version 20.2.0) while preserving the legacy method. The new approach provides more features with fewer requirements and includes built-in formatting for all locales based on Intl.

Changes:

  • Introduced new localization system with provideIgniteIntl() and setCurrentI18n() APIs
  • Added comprehensive documentation for locale settings, formatting options, and resource string management
  • Marked the previous localization approach as legacy while keeping it functional

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 13 comments.

File Description
en/components/toc.yml Marks the localization topic as updated in the table of contents
en/components/grids_templates/column-types.md Adds note about new formatting options and references new localization topic
en/components/general/localization.md Major update: adds new localization section with comprehensive documentation and marks old approach as legacy
cspell.json Adds "subtag" to custom dictionary for spell checking

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread en/components/general/localization.md
Comment thread en/components/general/localization.md Outdated
Comment thread en/components/general/localization.md Outdated
Comment thread en/components/general/localization.md Outdated

#### Angular API

You can use also Angular's built in [LOCALE_ID](https://angular.dev/api/core/LOCALE_ID) token the set the locale for the whole application. The tag provided will work the same way for our components compared to how our API handles.
Copy link

Copilot AI Feb 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The sentence 'The tag provided will work the same way for our components compared to how our API handles' is incomplete. It should be 'how our API handles it' or rephrase for clarity.

Suggested change
You can use also Angular's built in [LOCALE_ID](https://angular.dev/api/core/LOCALE_ID) token the set the locale for the whole application. The tag provided will work the same way for our components compared to how our API handles.
You can also use Angular's built-in [LOCALE_ID](https://angular.dev/api/core/LOCALE_ID) token to set the locale for the whole application. The tag provided will work the same way for our components as it does when using our API.

Copilot uses AI. Check for mistakes.
Comment thread en/components/general/localization.md Outdated
Comment thread en/components/general/localization.md Outdated

#### Language and formatting

If you would like to set different from the global localization for a component, you can do that be setting the `locale` property. The will affect the language of the resource strings used as well as the formatting, since they are tied together.
Copy link

Copilot AI Feb 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replace 'The will affect' with 'This will affect' to correct the grammar.

Suggested change
If you would like to set different from the global localization for a component, you can do that be setting the `locale` property. The will affect the language of the resource strings used as well as the formatting, since they are tied together.
If you would like to set different from the global localization for a component, you can do that be setting the `locale` property. This will affect the language of the resource strings used as well as the formatting, since they are tied together.

Copilot uses AI. Check for mistakes.
Comment thread en/components/general/localization.md Outdated
Comment thread en/components/general/localization.md Outdated
Comment thread en/components/general/localization.md Outdated
The appearance of the date portions will be set (e.g. day, month, year) based on [`locale`]({environment:angularApiUrl}/classes/igxgridcomponent.html#locale) format or [`pipeArgs`]({environment:angularApiUrl}/classes/igxcolumncomponent.html#pipeArgs) input. The pipe arguments can be used to specify a custom [date format](https://angular.io/api/common/DatePipe#pre-defined-format-options) or [timezone](https://angular.io/api/common/DatePipe#parameters):

- **format** - The default value for formatting the date is 'mediumDate'. Other available options are 'short', 'long', 'shortDate', 'fullDate', 'longTime', 'fulLTime' and etc. This is a full list of all available [pre-defined format options](https://angular.io/api/common/DatePipe#pre-defined-format-options).
- **format** - The default value for formatting the date is 'mediumDate'. Other available options are 'short', 'long', 'shortDate', 'fullDate', 'longTime', 'fulLTime' and etc. This is a full list of all available [pre-defined Angular format options](https://angular.io/api/common/DatePipe#pre-defined-format-options) (legacy).
Copy link

Copilot AI Feb 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The capitalization in 'fulLTime' is inconsistent. It should be 'fullTime' to match the pattern of other format options.

Copilot uses AI. Check for mistakes.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot sure, can you suggest commit?

dkamburov and others added 10 commits February 5, 2026 11:25
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

Copilot AI commented Feb 5, 2026

@dkamburov I've opened a new pull request, #6364, to work on those changes. Once the pull request is ready, I'll request review from you.

Copilot AI and others added 2 commits February 5, 2026 11:34
* Initial plan

* fix: correct capitalization of 'fullTime' in column-types.md

Co-authored-by: dkamburov <1182001+dkamburov@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: dkamburov <1182001+dkamburov@users.noreply.github.com>
@dkamburov dkamburov merged commit e51e063 into vnext Feb 5, 2026
5 checks passed
@dkamburov dkamburov deleted the skrastev/localization branch February 5, 2026 15:48
randriova added a commit that referenced this pull request Feb 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants