9 |
10 |
11 | 
12 |
13 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
22 |
23 | This is what the plugin looks like when we are in list view:
24 |
25 | 
26 |
27 | ### 🖐 Requirements
28 |
29 | Complete installation requirements are exact same as for Strapi itself and can be found in the documentation under Installation Requirements.
30 |
31 | **Supported Strapi versions**:
32 |
33 | - Strapi v3.6.x only version v1.0.0
34 | - Strapi v3.4.x only version v0.2.76
35 |
36 | **We recommend always using the latest version of Strapi to start your new projects**.
37 |
38 | ### ⏳ Installation
39 |
40 | ```bash
41 | # npm
42 | npm install strapi-plugin-preview-content
43 |
44 | # yarn
45 | yarn add strapi-plugin-preview-content
46 | ```
47 |
48 | ### 📁 Copy required files
49 |
50 | Inside `strapi-files` we have a list of folders with the Strapi version, enter to the version that correspond with your installation, and you will see this files
51 |
52 | 
53 |
54 | Copy the folder named `content-manager` inside your `
87 |
88 | #### Base url
89 |
90 | Here you can configure the base url of your frontend. This is a seperate field because it will be different depending on whether your project is running locally (e.g. `http://localhost:3000`) oder in production (e.g. `https://your-site.com`).
91 |
92 | #### Default preview url
93 |
94 | This is the default preview url the plugin uses for when your content type doesn't have its own url defined. For the default preview url there are three parameters provided by this plugin:
95 |
96 | | Parameter | Description |
97 | |-----------------|-----------------------------------|
98 | | `:baseUrl` | See section above for explanation |
99 | | `:contentType` | The content type to query |
100 | | `:id` | The id of content to query |
101 |
102 | For example in NextJS you can make use of [serverless functions](https://nextjs.org/docs/api-routes/introduction) to make an URL like this:
103 |
104 | `:baseUrl/api/preview/:contentType/:id`
105 |
106 | With your base url being `http://localhost:3000`, for example.
107 |
108 | And put the logic there to render content.
109 |
110 | #### Custom preview url
111 |
112 | You can also provide a custom url per content type in its `*.settings.json`. To do so, add this line to its options:
113 |
114 | ```diff
115 | {
116 | "pluginOptions": {
117 | "preview-content": {
118 | "previewable": true,
119 | + "url": ":baseUrl/your-path/:contentType/:id?a-custom-param=true"
120 | }
121 | }
122 | }
123 | ```
124 |
125 | Here you can see how the base url comes in handy: You cannot change the model in production, but you can change the base url in the settings.
126 |
127 | #### Adding data to the url
128 |
129 | To tell the plugin to allow injection of an entry's data add the following to your model's `*.settings.json`:
130 |
131 | ```diff
132 | {
133 | "pluginOptions": {
134 | "preview-content": {
135 | "previewable": true,
136 | + "url": ":baseUrl/your-path/:contentType/<%= slug %>?a-custom-param=<%= title %>",
137 | + "usesValuesInUrl": true
138 | }
139 | }
140 | }
141 | ```
142 |
143 | The plugin will now replace `<%= slug %>` and `<%= title %>` with the correct values. What you put in the brackets (`<%=` `%>`) has to be a name of the an attribute.
144 | The syntax used here is [lodash's template syntax](https://lodash.com/docs/4.17.15#template).
145 |
146 | ### ✨ Features
147 |
148 | ### 🛠 API
149 |
150 | There are some functions that make all of this posible
151 |
152 | | function | route | method | description | notes |
153 | | --------------- | ------------------------------- | ------ | ------------------------------------------------------------- | ------------------------------------------------------------------------------ |
154 | | `isPreviewable` | `/is-previewable/:contentType` | `GET` | Get if preview services is active in the current current type | |
155 | | `findOne` | `/:contentType/:id` | `GET` | Find a content type by id | You may want to active this route as public to make request from your frontend |
156 | | `getPreviewUrl` | `/preview-url/:contentType/:id` | `GET` | Get preview url of content type | |
157 |
158 | ## Contributing
159 |
160 | Feel free to fork and make a Pull Request to this plugin project. All the input is warmly welcome! To learn how, head [here](/CONTRIBUTING.md).
161 |
162 | ## Community support
163 |
164 | For general help using Strapi, please refer to [the official Strapi documentation](https://strapi.io/documentation/). For additional help, you can use one of these channels to ask a question:
165 |
166 | - [Slack](http://slack.strapi.io) We're present on official Strapi slack workspace. Look for @danestves and DM.
167 | - [GitHub](https://github.com/danestves/strapi-plugin-preview-content/issues) (Bug reports, Contributions, Questions and Discussions)
168 |
169 | ## License
170 |
171 | [MIT License](LICENSE.md) Copyright (c) 2020 [Daniel Esteves](https://danestves.com/) & [Strapi Solutions](https://strapi.io/).
172 |
173 | ## Contributors ✨
174 |
175 | Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
176 |
177 |
178 |
179 |
180 |  polcode-dzielonka 💻 |
183 |  p_0g_8mm3_ 💻 |
184 |  Ahmed Rafik Ibrahim 💻 |
185 |