Add documentation for new locale information methods #198
Conversation
| App::getLocale(); | ||
| App::getLocaleCountryCode(); | ||
| App::getSystemLocale(); |
There was a problem hiding this comment.
| App::getLocale(); | |
| App::getLocaleCountryCode(); | |
| App::getSystemLocale(); | |
| App::getLocale(); // fr_FR | |
| App::getLocaleCountryCode(); // fr | |
| App::getSystemLocale(); // fr_FR.UTF-8 |
Can we add an example output? (I don't know if my comments are correct)
There was a problem hiding this comment.
The only change I would suggest is to include an example after each line instead of explaining it below. Additionally, it would be helpful to elaborate on the difference between app local and system local, providing an example of where users can change this on Windows and/or Mac.
|
Sorry @SRWieZ, it took a while, but I wanted to check the returned values both under macOS and Windows. I have also added two external links which I believe to be helpful - is this ok? |
This PR allows developers to obtain localisation information of the application and the system via the
Appfacade.It adds three new methods to the facade that are proxies for the Electron methods
app.getLocale(),app.getLocaleCountryCode(), andapp.getSystemLocale()(see details on the Electron documentation). This allows developers to improve the localisation of their application, e.g. by automatically setting or suggesting a language that matches the system language when a NativePHP application is first launched.Electron PR: NativePHP/electron#247
Laravel PR: NativePHP/laravel#681
If there's anything you'd like me to tweak or improve in this PR, please let me know. 😊