forked from bootscore/bs-swiper
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathreadme.txt
401 lines (227 loc) · 7.36 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
=== bs Swiper ===
Contributors: Bastian Kreiter, torricelli, Sean Emerson, Dog Byte Marketing
Stable tag: 5.8.3
Tested up to: 6.6
Requires at least: 5.0
Requires PHP: 7.4
License: MIT License
License URI: https://github.com/bootscore/bs-swiper/blob/main/LICENSE
Plugin to show posts, pages, custom post types or WooCommerce products in a swiper.js carousel in Bootscore theme. Copyright 2021 - 2024 Bootscore.
== Credits ==
- Swiper: https://swiperjs.com/, MIT License, https://github.com/nolimits4web/swiper/blob/master/LICENSE, Copyright 2015, Vladimir Kharlampidi
- Update Checker https://github.com/YahnisElsts/plugin-update-checker/blob/master/license.txt, Copyright 2017, Jānis Elsts
== Installation ==
1. In your admin panel, go to Plugins > and click the Add New button.
2. Click Upload Plugin and Choose File, then select the Plugin's .zip file. Click Install Now.
3. Click Activate to use your new Plugin right away.
== Usage ==
= Posts =
Use shortcode to show posts somewhere:
Cards:
[bs-swiper-card type="post" category="cars, boats" order="DESC" orderby="date" posts="4"]
Cards Autoplay:
[bs-swiper-card-autoplay type="post" category="cars, boats" order="DESC" orderby="date" posts="4"]
Heroes:
[bs-swiper-hero type="post" category="cars, boats" order="DESC" orderby="date" posts="4"]
Heroes Fade:
[bs-swiper-hero-fade type="post" category="cars, boats" order="DESC" orderby="date" posts="4"]
Options:
category="" category-slug
order="" ASC or DESC
orderby="" date, title or rand
posts="" amount of posts to show
categories="false" hide categories badges
excerpt="false" hide excerpt
tags="false" hide tags badges
= Pages =
Use shortcode to show child pages somewhere:
Cards:
[bs-swiper-card type="page" post_parent="1891" order="ASC" orderby="title" posts="6"]
Cards Autoplay:
[bs-swiper-card-autoplay type="page" post_parent="1891" order="ASC" orderby="title" posts="6"]
Heroes:
[bs-swiper-hero type="page" post_parent="1891" order="ASC" orderby="title" posts="6"]
Heroes Fade:
[bs-swiper-hero-fade type="page" post_parent="1891" order="ASC" orderby="title" posts="6"]
Options:
post_parent="" ID of parent page
order="" ASC or DESC
orderby="" date, title or rand
posts="" amount of pages to show
excerpt="false" hide excerpt
= Custom Post Types =
Use shortcode to show custom post types somewhere:
Cards:
[bs-swiper-card type="isotope" tax="isotope_category" terms="dogs, cats" order="DESC" orderby="date" posts="5"]
Cards Autoplay:
[bs-swiper-card-autoplay type="isotope" tax="isotope_category" terms="dogs, cats" order="DESC" orderby="date" posts="5"]
Heroes:
[bs-swiper-hero type="isotope" tax="isotope_category" terms="dogs, cats" order="DESC" orderby="date" posts="5"]
Heroes Fade:
[bs-swiper-hero-fade type="isotope" tax="isotope_category" terms="dogs, cats" order="DESC" orderby="date" posts="5"]
Options:
type="" type of custom post type
tax="" taxonomy
terms="" terms-slug - multiple terms separated by comma
order="" ASC or DESC
orderby="" date, title or rand
posts="" amount of posts to show
excerpt="false" hide excerpt
= Products =
Use shortcode to show products somewhere:
[bs-swiper-card-product category="shoes, trousers" order="DESC" orderby="date" posts="12"]
Options:
category="" category-slug, multiple categories separated by comma
order="" ASC or DESC
orderby="" date, title or rand
posts="" number of posts to display
featured="true" - Will pull featured products (Default: false)
outofstock="false" - Will hide out of stock products (Default: true)
onsale="true" - Will show only onsale products (Default: '')
showhidden="true" Shows products hidden from catalog (Default: false)
== Changelog ==
= 5.8.3 - August 15 2024 =
#### Update
* Swiper 11.1.8
= 5.8.2 - July 24 2024 =
#### Update
* Swiper 11.1.7
= 5.8.1 - July 15 2024 =
#### Improvement
* Added `icon.svg`
#### Update
* Swiper 11.1.5
= 5.8.0 - June 06 2024 =
#### Feature
* Added a filter to change related posts heading title
#### Update
* Swiper 11.1.4
#### Templates changed
* `related-posts.php`
= 5.7.2 - March 28 2024 =
#### Bugfix
* Term field name to slug
#### Update
* Update checker 5.4
* Swiper 11.0.7
= 5.7.1 - February 13 2024 =
#### Improvement
* Moved `css` and `js` to `assets` folder
* Minified styles and scripts and added source
#### Update
* Swiper 11.0.6
= 5.7.0 - January 16 2024 =
#### Feature
* Rewrite locate template script to skip `-main` suffix in child folder
* Add filter to remove related posts
#### Improvement
* Replaced `text-muted` with `text-body-secondary`
* `-main` branch suffix from plugin's folder. This does not affect existing bs-swiper-main installations.
* Classes in hero templates
#### Bugfix
* Remove related posts if no other posts in the same category are available
#### Update
* Update checker 5.3
= 5.6.0 - November 28 2023 =
#### Feature
* Added brand and onsale attribute
* Product template shortcode options
* Procuct attribute to show the hidden products
#### Improvement
* Revert limit 12 products to posts -1
* Added sanitization and the extract replacement to the other templates
#### Bugfix
* Products with visibility set to none are currently being displayed
* Possibility to get non published posts
#### Update
* Update checker v5
* Swiper 11.0.5
= 5.5.0 - October 16 2023 =
#### Feature
* Attribute for handling OOS products
= 5.4.0 - September 14 2023 =
#### Feature
* Added featured products attribute
* Added ability to disable excerpt, categories and tags badges
#### Bugfix
* Product shortcode triggering error when category is empty
= 5.3.2 - August 27 2023 =
#### Bugfix
* Downgrade to update checker 4
= 5.3.1 - August 26 2023 =
#### Improvement
* Deny direct access
#### Bugfix
* Tags badges in heroes
#### Update
* Plugin update checker 5.2
= 5.3.0 - August 11 2023 =
#### Feature
* Related posts template
#### Improvement
* Change --bs-primary to --bs-link-color (Dark Mode)
#### Bugfix
* Undefined variable in sc-product.php
= 5.2.1 - April 26 2023 =
#### Improvement
* Replace PHP echo's with shorthand
* Change bullet CSS variable to body color
= 5.2.0 - March 31 2023 =
#### Improvement
* Loop cards
= 5.1.0.7 - December 21 2022 =
#### Feature
* Added composer.json
* Added card autoplay template
#### Update
* Update Swiper 8.4.5
= 5.1.0.6 - September 06 2022 =
#### Improvement
* Fix product star rating
= 5.1.0.5 - July 27 2022 =
#### Update
* Swiper 8.3.2
= 5.1.0.4 - June 28 2022 =
#### Improvement
* Reformat all files
#### Update
* Swiper 8.2.5
= 5.1.0.3 - June 10 2022 =
#### Update
* Swiper 8.2.3
= 5.1.0.2 - April 16 2022 =
#### Update
* Swiper 8.1.1
= 5.1.0.1 - February 03 2022 =
#### Update
* Swiper 8.0.2
= 5.1.0.0 - January 10 2022 =
#### Feature
* Added shortcode to show single items by id
* Added shortcode for custom post types by terms-slug
#### Removed
* Shortcode for CPT by parent terms id
#### Improvement
* Template sc-swiper-card.php
* Template sc-swiper-hero.php
* Template sc-swiper-hero-fade.php
#### Update
* Swiper 7.3.4
= 5.0.0.4 - October 23 2021 =
#### Improvement
* Added bg-dark class to heroes
#### Update
* Swiper 7.0.9
= 5.0.0.3 - September 09 2021 =
#### Feature
* Changed repository and plugin name
#### Update
* Swiper 7.0.4
= 5.0.0.2 - August 12 2021 =
#### Feature
* Added new hero-fade template
= 5.0.0.1 - August 02 2021 =
#### Removed
* Source map in swiper-bundle.min.js
= 5.0.0.0 - July 29 2021 =
* Initial release