@salla.sa/twilight 2.12.29 → 2.12.31
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -55,7 +55,7 @@
|
|
|
55
55
|
**SDK** stands for "software development kit," and it refers to a library for interacting with a specific REST API using JavaScript.
|
|
56
56
|
|
|
57
57
|
### SDK's main APIs
|
|
58
|
-
The main parts of the **Twilight JS SDK**
|
|
58
|
+
The main parts of the **Twilight JS SDK** include REST API endpoints that ease the actions related to the APIs request, such as:
|
|
59
59
|
- **Authorization APIs:** Several endpoints for customer logging in, logging out, and many more.
|
|
60
60
|
- **Cart APIs:** Customer's cart list of endpoints.
|
|
61
61
|
- **Comments APIs:** Group of endpoints related to the customer comments, or feedback, on product or page.
|
|
@@ -78,7 +78,7 @@ Following are some of the possible uses of the Twilight JS SDK:
|
|
|
78
78
|
<p align="right">(<a href="#top">back to top</a>)</p>
|
|
79
79
|
|
|
80
80
|
## Installation and initialization
|
|
81
|
-
**Twilight JS SDK** can be used without the need to be downloaded or installed; instead it needs to be included as a short piece of regular JavaScript in the HTML that will asynchronously load the SDK into the Twilight theme.
|
|
81
|
+
**Twilight JS SDK** can be used without the need to be downloaded or installed; instead, it needs to be included as a short piece of regular JavaScript in the HTML that will asynchronously load the SDK into the Twilight theme.
|
|
82
82
|
|
|
83
83
|
#### Twilight Themes
|
|
84
84
|
In case of using the **Twilight JS SDK** inside the Twilight themes, the developer doesn't need to include the **Twilight JS SDK** in the theme project's bundle or inside the html, **Twilight theme engine** will inject the latest version of the **Twilight JS SDK** in the page.
|
|
@@ -108,7 +108,7 @@ The following snippet of code will give the basic version of the SDK where the c
|
|
|
108
108
|
```
|
|
109
109
|
|
|
110
110
|
#### Bundler/ES modules
|
|
111
|
-
|
|
111
|
+
The developer may also install the **Twilight JS SDK** using the following commands:
|
|
112
112
|
|
|
113
113
|
```npm title="NPM Installation Command"
|
|
114
114
|
npm install @salla.sa/twilight --save
|
|
@@ -125,7 +125,7 @@ Initially, the developer must import the Salla JS Events library as follows:
|
|
|
125
125
|
import '@salla.sa/twilight';
|
|
126
126
|
```
|
|
127
127
|
|
|
128
|
-
|
|
128
|
+
Similar to the [HTML/CDN section](https://github.com/SallaApp/twilight/blob/master/packages/twilight/README.md#html-and-cdn), the following code snippet will give the basic version of the SDK where the configurations are set to their minimum requirements, wherein the method `salla.init()` is used to setup and initialize the SDK.
|
|
129
129
|
|
|
130
130
|
```js
|
|
131
131
|
<script>
|
|
@@ -203,7 +203,7 @@ salla.config.set('debug', true)
|
|
|
203
203
|
```
|
|
204
204
|
|
|
205
205
|
#### Get configuration value
|
|
206
|
-
Similarly, the developer can use the method
|
|
206
|
+
Similarly, the developer can use the method `salla.config.get()` to get any value from the configuration file. To retrieve a simple value such as the user Id, the following syntax can be followed:
|
|
207
207
|
|
|
208
208
|
```js
|
|
209
209
|
salla.config.get('user.id’)
|
|
@@ -212,14 +212,14 @@ salla.config.get('user.id’)
|
|
|
212
212
|
Furthermore, if the required value is nested inside an inner value, such as a currency code, the following syntax can be followed:
|
|
213
213
|
|
|
214
214
|
```js
|
|
215
|
-
salla.config.get('
|
|
215
|
+
salla.config.get('currencies.SAR.code’)
|
|
216
216
|
```
|
|
217
217
|
|
|
218
218
|
<p align="right">(<a href="#top">back to top</a>)</p>
|
|
219
219
|
|
|
220
220
|
## Support
|
|
221
221
|
|
|
222
|
-
The team is always here to help you. Happen to face an issue? Want to report a bug? You can submit one here on
|
|
222
|
+
The team is always here to help you. Happen to face an issue? Want to report a bug? You can submit one here on GitHub using the [Issue Tracker](https://github.com/SallaApp/twilight-vscode-extension/issues/new). If you still have any questions, please contact us via the [Telegram Bot](https://t.me/SallaSupportBot) or join the Global Developer Community on [Telegram](https://t.me/salladev).
|
|
223
223
|
|
|
224
224
|
<p align="right">(<a href="#top">back to top</a>)</p>
|
|
225
225
|
|