docs: cleanup and organize core reference

Author: rigor789

.vitepress/config.mts

@@ -1,5 +1,6 @@
 import { defineConfig } from 'vitepress'
 import apiSidebar from '../content/api/sidebar.json'
+import coreSidebar from '../content/core/sidebar'
 import mainSidebar from '../content/sidebar'
 import uiSidebar from '../content/ui/sidebar'
 import nav from './nav'
@@ -37,6 +38,7 @@ export default defineConfig({
     nav,
     sidebar: {
       '/api': apiSidebar,
+      '/core': coreSidebar,
       '/ui': uiSidebar,
       '/': mainSidebar,
     },

.vitepress/nav.ts

@@ -12,7 +12,7 @@ export default [
   {
     text: 'Docs',
     link: '/',
-    activeMatch: '^/(?!plugins|best-practices|api|dev-reference|tutorials|ui)',
+    activeMatch: '^/(?!plugins|best-practices|api|dev-reference|tutorials|ui|core)',
     icon: 'BookOpenIcon',
   },
 
@@ -50,6 +50,12 @@ export default [
     activeMatch: '^/ui',
     icon: 'CubeTransparentIcon',
   },
+  {
+    text: 'Core Reference',
+    link: '/core/',
+    activeMatch: '^/core',
+    icon: 'CodeBracketIcon',
+  },
   {
     text: 'API Reference',
     link: '/api/',

content/guide/core/application-settings.md renamed to content/core/application-settings.md

@@ -14,8 +14,9 @@ description: Persist data locally on the device storage
 To store a string value, use the [setString](#setstring) method:
 
 ```ts
-ApplicationSettings.setString("username", "Wolfgang");
+ApplicationSettings.setString('username', 'Wolfgang')
 ```
+
 :::tip :green_circle: Tip
 You can use this method with the `JSON.stringify()` (as shown in the `saveObjectAsString` method in the StackBlitz demo app at the link above) to store an object or an array as a string. Then, use `JSON.parse()` to convert the result of [getString()](#getstring) back to the object or array.
 :::
@@ -25,15 +26,15 @@ You can use this method with the `JSON.stringify()` (as shown in the `saveObject
 To store a boolean value, call the [setBoolean](#setboolean) method passing the key as the first argument and the value as second argument.
 
 ```ts
-ApplicationSettings.setBoolean("isTurnedOn", true);
+ApplicationSettings.setBoolean('isTurnedOn', true)
 ```
 
 ### Store a numeric value
 
 To store a number, use the [setNumber()](#setnumber) method:
 
 ```ts
-ApplicationSettings.setNumber("locationX", 54.321);
+ApplicationSettings.setNumber('locationX', 54.321)
 ```
 
 ## ApplicationSettings API
@@ -94,7 +95,7 @@ Sets a `boolean` for a key.
 ApplicationSettings.getBoolean(key: string, deafaultValue?: boolean)
 ```
 
-Gets a value (if existing) for a key as a `boolean`.  A default value can be provided in case the value does not exist.value.
+Gets a value (if existing) for a key as a `boolean`. A default value can be provided in case the value does not exist.value.
 
 ---
 
@@ -123,14 +124,16 @@ Removes all values from the device storage.
 ```ts
 ApplicationSettings.getAllKeys(): Array<string>
 ```
+
 Returns an array of all stored keys or an empty array if no keys exist in the device storage.
 
 ---
 
-
 ## API Reference(s)
+
 - [ApplicationSettings](https://docs.nativescript.org/api-reference/modules#applicationsettings) module
 
 ## Native Component
+
 - `Android`: [SharedPreferences](https://developer.android.com/reference/android/content/SharedPreferences)
 - `iOS`: [NSUserDefaults](https://developer.apple.com/documentation/foundation/nsuserdefaults)

content/guide/core/application.md renamed to content/core/application.md

@@ -10,68 +10,75 @@ The Application class provides the wrapper around [android.app.Application](http
 ### Register a broadcast receiver
 
 To register a broadcast receiver, you follow these 3 steps:
+
 1. Import the `Application` class from `@nativescript/core`.
-```ts
-import { Application, isAndroid } from '@nativescript/core';
-```
+
+   ```ts
+   import { Application, isAndroid } from '@nativescript/core'
+   ```
+
 2. Get the wrapper object for [android.app.Application](https://developer.android.com/reference/android/app/Application) instance.
-Use the `android` property to get the wrapper around [android.app.Application](https://developer.android.com/reference/android/app/Application).
+   Use the `android` property to get the wrapper around [android.app.Application](https://developer.android.com/reference/android/app/Application).
 
-```ts
-const androidApp: AndroidApplication = Application.android
-```
+   ```ts
+   const androidApp: AndroidApplication = Application.android
+   ```
 
 3. Call the [registerBroadcastReceiver](#registerbroadcastreceiver) method.
-Call the `registerBroadcastReceiver` method on `androidApp`.
-```ts
-androidApp.registerBroadcastReceiver()
-```
+   Call the `registerBroadcastReceiver` method on `androidApp`.
+
+   ```ts
+   androidApp.registerBroadcastReceiver()
+   ```
 
-For a complete example that shows how to register a broadcast receiver with a custom intent filter, visit the following link: 
+For a complete example that shows how to register a broadcast receiver with a custom intent filter, visit the following link:
 
 <!-- Preview: https://stackblitz.com/edit/nativescript-stackblitz-templates-khnhes?file=app/app.ts -->
+
 For system intent filters, see [Standard Broadcast Actions](https://developer.android.com/reference/android/content/Intent#standard-broadcast-actions).
 
 ### Unregister a broadcast receiver
 
 To unregister a broadcast receiver, call the [unregisterBroadcastReceiver](#unregisterbroadcastreceiver) on the wrapper around an [android.app.Application](https://developer.android.com/reference/android/app/Application) passing it the intent filter for which to unregister the broacast receiver. The example below unregisters a broadcast receiver for the `android.content.Intent.ACTION_BATTERY_CHANGED` intent filter.
 
 ```ts
-import { Application, isAndroid } from '@nativescript/core';
-if(isAndroid){
-const androidApp: AndroidApplication = Application.android
+import { Application, isAndroid } from '@nativescript/core'
+if (isAndroid) {
+  const androidApp: AndroidApplication = Application.android
 
-androidApp.unregisterBroadcastReceiver(android.content.Intent.ACTION_BATTERY_CHANGED);
+  androidApp.unregisterBroadcastReceiver(
+    android.content.Intent.ACTION_BATTERY_CHANGED
+  )
 }
-
 ```
 
 ### Add a notification observer
 
-To add an iOS notification observer, follow the steps below: 
+To add an iOS notification observer, follow the steps below:
 
 1. Import the `Application` class from `@nativescript/core`.
 
-```ts
-import { Application, isIOS } from '@nativescript/core';
-```
+   ```ts
+   import { Application, isIOS } from '@nativescript/core'
+   ```
 
 2. Get the wrapper object for [UIApplication](https://developer.apple.com/documentation/uikit/uiapplication?language=objc) instance.
-```ts
-const iOSApp: iOSApplication = Application.ios
-```
+
+   ```ts
+   const iOSApp: iOSApplication = Application.ios
+   ```
 
 3. Call the `addNotificationObserver` method.
-Call the `addNotificationObserver` passing it the name of the notification([NSNotificationName](https://developer.apple.com/documentation/foundation/nsnotificationname)) you would like to observe as the first parameter and as a second parameter, a callback function to be called when that notification occurs.
+   Call the `addNotificationObserver` passing it the name of the notification([NSNotificationName](https://developer.apple.com/documentation/foundation/nsnotificationname)) you would like to observe as the first parameter and as a second parameter, a callback function to be called when that notification occurs.
 
-```ts
-const observer: any = iOSApp.addNotificationObserver(
-  UIDeviceOrientationDidChangeNotification, 
-  (notification: NSNotification) => {
-    //Handle the notification
-  }
-)
-```
+   ```ts
+   const observer: any = iOSApp.addNotificationObserver(
+     UIDeviceOrientationDidChangeNotification,
+     (notification: NSNotification) => {
+       //Handle the notification
+     }
+   )
+   ```
 
 Find the complete example [here](https://stackblitz.com/edit/nativescript-stackblitz-templates-khnhes?file=app%2Fapp.ts%3AL14)
 
@@ -80,11 +87,14 @@ Find the complete example [here](https://stackblitz.com/edit/nativescript-stackb
 To remove a notification observer, use the `removeNotificationObserver` method on a `Application.ios` reference the observer id, returned by the `addNotificationObserver` as the first argument and the name of the notification to stop observing.
 
 ```ts
-iOSApp.removeNotificationObserver(observer, UIDeviceBatteryStateDidChangeNotification)
+iOSApp.removeNotificationObserver(
+  observer,
+  UIDeviceBatteryStateDidChangeNotification
+)
 ```
 
-
 ## Cross platform application events
+
 This class allows you to listen to the following lifecycle events on both platforms.
 
 ```ts
@@ -110,49 +120,68 @@ Application.on('orientationChanged', (args: ApplicationEventData) => {
 - `fontScaleChanged`
 
 :::
+
 ## getResources()
+
 ```ts
 resources: any = Application.getResources()
 ```
+
 Gets application-level static resources.
 
 ---
+
 ## setResources()
+
 ```ts
 Application.setResources(resources)
 ```
+
 Sets application-level static resources.
 
 ---
+
 ## setCssFileName()
+
 ```ts
 Application.setCssFileName(filePath)
 ```
+
 Sets css file name for the application.
 
 ---
+
 ## getCssFileName()
+
 ```ts
 cssFileName: string = Application.getCssFileName()
 ```
+
 Gets css file name for the application.
 
 ---
+
 ## loadAppCss()
+
 ```ts
 loadedCss: any = Applicatioin.loadAppCss()
 ```
+
 Loads immediately the app.css. By default the app.css file is loaded shortly after "loaded". For the Android snapshot the CSS can be parsed during the snapshot generation, as the CSS does not depend on runtime APIs, and loadAppCss will be called explicitly.
 
 ---
+
 ## addCss()
+
 ```ts
 Application.addCss(cssText, attributeScoped)
 ```
+
 Adds new values to the application styles.
+
 - `cssText` - A valid CSS styles to be add to the current application styles.
 - _Optional_: `attributeScoped` - sets whether the styles are attribute scoped. Adding attribute scoped styles does not perform a full application styling refresh.
- 
+
 ---
 
 ## Android Reference
@@ -171,15 +200,14 @@ The property gives you the `AndroidApplication` object, a Nativescript wrapper,
 
 ```ts
 nativeApp: android.app.Application = androidApp.nativeApp
-// or 
+// or
 nativeApp: UIApplication = iOSApp.nativeApp
 ```
 
-This is a native application reference. 
+This is a native application reference.
 
 For Android, it is the [android.app.Application](http://developer.android.com/reference/android/app/Application.html) instance keeping track of the global application state. From this object you can get methods such as getFilesDir(), onLowMemory(),etc.
 
-
 For iOS, it returns the reference to a [UIApplication](https://developer.apple.com/documentation/uikit/uiapplication?language=objc) instance for the application.
 
 ---
@@ -258,10 +286,10 @@ Unregisters a previously registered BroadcastReceiver for the specified intent f
 
 ### Android Activity lifecycles events
 
-To handle the application lifecycle events for Android, use `on` method of the 
+To handle the application lifecycle events for Android, use `on` method of the
 
 ```ts
-androidApp.on('activityResumed', args => {
+androidApp.on('activityResumed', (args) => {
   //handle the event here
 })
 ```
@@ -282,7 +310,9 @@ androidApp.on('activityResumed', args => {
 :::
 
 ---
+
 ## iOS Reference
+
 ### ios
 
 ```ts
@@ -385,8 +415,6 @@ Returns whether the system appearance is `dark`, `light` or `null`(for iOS <= 11
 
 ---
 
-
-
 :::details References
 
 ## API References
@@ -401,4 +429,4 @@ Returns whether the system appearance is `dark`, `light` or `null`(for iOS <= 11
 | :----------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------- |
 | [android.app.Application](https://developer.android.com/reference/android/app/Application) | [UIApplication](https://developer.apple.com/documentation/uikit/uiapplication?language=objc) |
 
-:::
+:::