Skip to content

Commit 26de94d

Browse files
AmitkanswalAmitkanswal
authored
Merge branch 'staging' into feat/MKT-15625-setData
2 parents 5018fcd + b9406ea commit 26de94d

2 files changed

Lines changed: 299 additions & 121 deletions

File tree

‎README.md‎

Lines changed: 121 additions & 121 deletions
Original file line numberDiff line numberDiff line change
@@ -1,145 +1,145 @@
11
<!-- ⚠️ This README has been generated from the file(s) "./.github/readme/blueprint.md" ⚠️-->
22
[](#contentstack-app-sdk-readme)
33

4-
# Contentstack App SDK Readme
5-
6-
The Contentstack App SDK allows you to customize your applications. This document will help you integrate the App SDK with your application.
7-
4+
# Contentstack App SDK Readme
5+
6+
The Contentstack App SDK allows you to customize your applications. This document will help you integrate the App SDK with your application.
7+
88

99
[](#getting-started)
1010

11-
## Getting started
12-
13-
Include the compiled version of the extension client library by adding the following line to your application.
14-
15-
```html
16-
<script
17-
src="https://unpkg.com/@contentstack/app-sdk@2.4.0/dist/index.js"
18-
integrity="sha512-mPQQ5ZV/ovd9XSNp4OK6PVCtqFc+oTah9qacLs8uydezibUGxCuxfmVj/+QSop80rDpYa92duh41SpTh8mE44A=="
19-
crossorigin="anonymous"
20-
></script>
21-
```
22-
23-
To include the App SDK in your project, you need to run the following command:
24-
25-
```sh
26-
npm install @contentstack/app-sdk
27-
```
28-
29-
Alternatively, you can use the following command within the script tag to install the App SDK:
30-
31-
```html
32-
<script src="https://unpkg.com/@contentstack/app-sdk@2.0.0/dist/index.js"></script>
33-
```
34-
35-
### Initializing the App SDK
36-
37-
To Initialize the App SDK you need to run the following command:
38-
39-
```js
40-
ContentstackAppSdk.init().then(function (appSdk) {
41-
// add code here
42-
});
43-
```
44-
45-
For more information, please refer to our [App SDK API Reference](https://github.com/contentstack/app-sdk-docs#contentstack-app-sdk-api-reference) document.
46-
11+
## Getting started
12+
13+
Include the compiled version of the extension client library by adding the following line to your application.
14+
15+
```html
16+
<script
17+
src="https://unpkg.com/@contentstack/app-sdk@2.4.0/dist/index.js"
18+
integrity="sha512-mPQQ5ZV/ovd9XSNp4OK6PVCtqFc+oTah9qacLs8uydezibUGxCuxfmVj/+QSop80rDpYa92duh41SpTh8mE44A=="
19+
crossorigin="anonymous"
20+
></script>
21+
```
22+
23+
To include the App SDK in your project, you need to run the following command:
24+
25+
```sh
26+
npm install @contentstack/app-sdk
27+
```
28+
29+
Alternatively, you can use the following command within the script tag to install the App SDK:
30+
31+
```html
32+
<script src="https://unpkg.com/@contentstack/app-sdk@2.3.6/dist/index.js"></script>
33+
```
34+
35+
### Initializing the App SDK
36+
37+
To Initialize the App SDK you need to run the following command:
38+
39+
```js
40+
ContentstackAppSdk.init().then(function (appSdk) {
41+
// add code here
42+
});
43+
```
44+
45+
For more information, please refer to our [App SDK API Reference](https://github.com/contentstack/app-sdk-docs#contentstack-app-sdk-api-reference) document.
46+
4747

4848
[](#download-the-boilerplate)
4949

50-
## Download the Boilerplate
51-
52-
You can extend or customize the functionality of Contentstack CMS with Marketplace apps. To simplify and speed up the building process, boilerplates describe repetitive elements in a project. This boilerplate will help you build custom applications for your organization or stack.
53-
54-
Download the [boilerplate](https://github.com/contentstack/marketplace-app-boilerplate/archive/refs/heads/master.zip).
55-
50+
## Download the Boilerplate
51+
52+
You can extend or customize the functionality of Contentstack CMS with Marketplace apps. To simplify and speed up the building process, boilerplates describe repetitive elements in a project. This boilerplate will help you build custom applications for your organization or stack.
53+
54+
Download the [boilerplate](https://github.com/contentstack/marketplace-app-boilerplate/archive/refs/heads/master.zip).
55+
5656

5757
[](#ui-locations-and-examples)
5858

59-
## UI Locations and Examples
60-
61-
UI Locations allow you to extend Contentstack's functionality. Through these UI locations, you can customize Contentstack's default behavior and UI. Integration of third-party applications is possible using different UI locations.
62-
63-
The Contentstack App SDK currently supports the following UI Locations:
64-
65-
- [Custom Field Location](https://www.contentstack.com/docs/developers/developer-hub/custom-field-location)
66-
- [Dashboard Location](https://www.contentstack.com/docs/developers/developer-hub/dashboard-location)
67-
- [Asset Sidebar Location](https://www.contentstack.com/docs/developers/developer-hub/asset-sidebar-location)
68-
- [App Config Location](https://www.contentstack.com/docs/developers/developer-hub/app-config-location)
69-
- [RTE Location](https://www.contentstack.com/docs/developers/developer-hub/rte-location)
70-
- [Sidebar Location](https://www.contentstack.com/docs/developers/developer-hub/sidebar-location)
71-
- [Field Modifier Location](https://www.contentstack.com/docs/developers/developer-hub/field-modifier-location/)
72-
- [Full Page Location](https://www.contentstack.com/docs/developers/developer-hub/full-page-location)
73-
74-
### Custom Field Location
75-
76-
Custom Field Location allows you to create custom fields that can be used in your content types. You can integrate with various business applications, such as [Bynder](https://www.contentstack.com/docs/developers/marketplace-apps/bynder), [Cloudinary](https://www.contentstack.com/docs/developers/marketplace-apps/cloudinary), [Shopify](https://www.contentstack.com/docs/developers/marketplace-apps/shopify), by adding them as a custom field to your stack's content type.
77-
78-
### Dashboard Location
79-
80-
With the Dashboard Location, you can create widgets for your stack dashboard. Integration with [Google Analytics](https://www.contentstack.com/docs/developers/marketplace-apps/google-analytics/) provides meaningful insights about your website.
81-
82-
### Asset Sidebar Location
83-
84-
Using the Asset Sidebar Location, you can create customized sidebar widgets to extend the functionality of your assets.
85-
86-
Manage, transform, and optimize your stack's assets efficiently using the [Image Preset Builder](https://www.contentstack.com/docs/developers/marketplace-apps/image-preset-builder).
87-
88-
### App Config Location
89-
90-
App Config UI Location allows you to manage all the app settings centrally. Once configured, all other locations (where the app is installed) can access these settings.
91-
92-
### RTE Location
93-
94-
The RTE Location allows you to create custom plugins to expand the functionality of your JSON Rich Text Editor. Using the Audience and Variables plugin, you can tailor your content as per your requirements.
95-
96-
### Sidebar Location
97-
98-
The Sidebar Location provides powerful tools for analyzing and recommending ideas for your entry. Use the [Smartling](https://help.smartling.com/hc/en-us/articles/4865477629083) sidebar location to help translate your content.
99-
100-
### Field Modifier Location
101-
102-
The Field Modifier Location is a type of UI location which extends the capabilities of entry fields. With the Field Modifier UI location, you can allow the different apps to appear on defined field data types such as Text, Number, JSON, Boolean, File, Reference fields etc.
103-
104-
### Full Page Location
105-
106-
The Full Page location is a type of UI location that lets you view full page apps such as [Release Preview](https://www.contentstack.com/docs/developers/marketplace-apps/release-preview) within your stack.
107-
59+
## UI Locations and Examples
60+
61+
UI Locations allow you to extend Contentstack's functionality. Through these UI locations, you can customize Contentstack's default behavior and UI. Integration of third-party applications is possible using different UI locations.
62+
63+
The Contentstack App SDK currently supports the following UI Locations:
64+
65+
- [Custom Field Location](https://www.contentstack.com/docs/developers/developer-hub/custom-field-location)
66+
- [Dashboard Location](https://www.contentstack.com/docs/developers/developer-hub/dashboard-location)
67+
- [Asset Sidebar Location](https://www.contentstack.com/docs/developers/developer-hub/asset-sidebar-location)
68+
- [App Config Location](https://www.contentstack.com/docs/developers/developer-hub/app-config-location)
69+
- [RTE Location](https://www.contentstack.com/docs/developers/developer-hub/rte-location)
70+
- [Sidebar Location](https://www.contentstack.com/docs/developers/developer-hub/sidebar-location)
71+
- [Field Modifier Location](https://www.contentstack.com/docs/developers/developer-hub/field-modifier-location/)
72+
- [Full Page Location](https://www.contentstack.com/docs/developers/developer-hub/full-page-location)
73+
74+
### Custom Field Location
75+
76+
Custom Field Location allows you to create custom fields that can be used in your content types. You can integrate with various business applications, such as [Bynder](https://www.contentstack.com/docs/developers/marketplace-apps/bynder), [Cloudinary](https://www.contentstack.com/docs/developers/marketplace-apps/cloudinary), [Shopify](https://www.contentstack.com/docs/developers/marketplace-apps/shopify), by adding them as a custom field to your stack's content type.
77+
78+
### Dashboard Location
79+
80+
With the Dashboard Location, you can create widgets for your stack dashboard. Integration with [Google Analytics](https://www.contentstack.com/docs/developers/marketplace-apps/google-analytics/) provides meaningful insights about your website.
81+
82+
### Asset Sidebar Location
83+
84+
Using the Asset Sidebar Location, you can create customized sidebar widgets to extend the functionality of your assets.
85+
86+
Manage, transform, and optimize your stack's assets efficiently using the [Image Preset Builder](https://www.contentstack.com/docs/developers/marketplace-apps/image-preset-builder).
87+
88+
### App Config Location
89+
90+
App Config UI Location allows you to manage all the app settings centrally. Once configured, all other locations (where the app is installed) can access these settings.
91+
92+
### RTE Location
93+
94+
The RTE Location allows you to create custom plugins to expand the functionality of your JSON Rich Text Editor. Using the Audience and Variables plugin, you can tailor your content as per your requirements.
95+
96+
### Sidebar Location
97+
98+
The Sidebar Location provides powerful tools for analyzing and recommending ideas for your entry. Use the [Smartling](https://help.smartling.com/hc/en-us/articles/4865477629083) sidebar location to help translate your content.
99+
100+
### Field Modifier Location
101+
102+
The Field Modifier Location is a type of UI location which extends the capabilities of entry fields. With the Field Modifier UI location, you can allow the different apps to appear on defined field data types such as Text, Number, JSON, Boolean, File, Reference fields etc.
103+
104+
### Full Page Location
105+
106+
The Full Page location is a type of UI location that lets you view full page apps such as [Release Preview](https://www.contentstack.com/docs/developers/marketplace-apps/release-preview) within your stack.
107+
108108

109109
[](#using-contentstack-styles)
110110

111-
## Using Contentstack styles
112-
113-
Install the Venus UI library package to style your app according to the Contentstack UI:
114-
115-
```sh
116-
npm i @contentstack/venus-components --save
117-
```
118-
119-
For more information on styling your application, refer to our [style guide](https://www.contentstack.com/docs/developers/venus-component-library/).
120-
111+
## Using Contentstack styles
112+
113+
Install the Venus UI library package to style your app according to the Contentstack UI:
114+
115+
```sh
116+
npm i @contentstack/venus-components --save
117+
```
118+
119+
For more information on styling your application, refer to our [style guide](https://www.contentstack.com/docs/developers/venus-component-library/).
120+
121121

122122
[](#more-information)
123123

124-
## More information
125-
126-
- [App SDK API Reference](https://github.com/contentstack/app-sdk-docs#readme)
127-
- [Marketplace Platform Guides](https://www.contentstack.com/docs/developers/marketplace-platform-guides/)
128-
- [Marketplace Apps](https://www.contentstack.com/docs/developers/marketplace-apps/)
129-
- [Contentstack App Development](https://www.contentstack.com/docs/developers/developer-hub/)
130-
124+
## More information
125+
126+
- [App SDK API Reference](https://github.com/contentstack/app-sdk-docs#readme)
127+
- [Marketplace Platform Guides](https://www.contentstack.com/docs/developers/marketplace-platform-guides/)
128+
- [Marketplace Apps](https://www.contentstack.com/docs/developers/marketplace-apps/)
129+
- [Contentstack App Development](https://www.contentstack.com/docs/developers/developer-hub/)
130+
131131

132132
[](#app-sdk-v200-migration-guide)
133133

134-
## App SDK v2.0.0 Migration Guide
135-
136-
This guide provides instructions for migrating your application to App SDK version 2.0.0. It covers changes in metadata responses, field modifier and full page location updates, and the transition from the `_extension` property to `_uiLocation`. If you are upgrading your app to the latest version, make sure to follow these steps for a smooth transition.
137-
138-
[Read the Migration Guide](./docs/app-sdk-v2-migration.md)
139-
134+
## App SDK v2.0.0 Migration Guide
135+
136+
This guide provides instructions for migrating your application to App SDK version 2.0.0. It covers changes in metadata responses, field modifier and full page location updates, and the transition from the `_extension` property to `_uiLocation`. If you are upgrading your app to the latest version, make sure to follow these steps for a smooth transition.
137+
138+
[Read the Migration Guide](./docs/app-sdk-v2-migration.md)
139+
140140

141141
[](#license)
142142

143-
## License
144-
145-
Licensed under [MIT](https://opensource.org/licenses/MIT).
143+
## License
144+
145+
Licensed under [MIT](https://opensource.org/licenses/MIT).

0 commit comments

Comments
 (0)