Skip to content

Commit 3c9d2d0

Browse files
committed
docs: add an option to show minimum version required to use the option
1 parent f5a4270 commit 3c9d2d0

File tree

5 files changed

+16
-1
lines changed

5 files changed

+16
-1
lines changed

site/assets/scss/docs/_options.scss

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,14 @@
2828
border-bottom-color: transparent;
2929
}
3030
}
31+
.docs-minimum-version {
32+
color: #666;
33+
font-size: 14px;
34+
b {
35+
margin-left: 3px;
36+
color: #333;
37+
}
38+
}
3139
}
3240
}
3341
.options-section {

site/content/docs/settings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ lightGallery
172172
## Vimeo thumbnails plugin
173173

174174
Vimeo thumbnails plugin helps you load thumbnails automatically for Vimeo videos.
175-
<span class="badge rounded-pill bg-danger font-12" title="Available since version 2.4.0">v2.5.0</span>
175+
<span class="badge rounded-pill bg-danger font-12" title="Available since version 2.5.0">v2.5.0</span>
176176

177177
{{< options pluginName="Vimeo Thumbnails" interface="VimeoThumbnailSettings" variable="vimeoSettings" >}}
178178

site/layouts/shortcodes/options.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,9 @@
6060
{{ if eq .tag "description"}}
6161
<p>{{.text | safeHTML}}</p>
6262
{{ end}}
63+
{{ if eq .tag "version"}}
64+
<p class="docs-minimum-version">Minimum lightGallery version required: <b>{{.text}}</b></p>
65+
{{ end}}
6366
{{ if eq .tag "example"}}
6467
{{ highlight .text "js" "" }}
6568
{{ end}}

src/lg-settings.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -261,13 +261,15 @@ export interface LightGalleryCoreSettings {
261261

262262
/**
263263
* Hide scrollbar when gallery is opened
264+
* @version V2.5.0
264265
*/
265266
hideScrollbar: boolean;
266267

267268
/**
268269
* Reset to previous scrollPosition when lightGallery is closed
269270
* @description By default, lightGallery doesn't hide the scrollbar for a smooth opening transition.
270271
* If a user changes the scroll position, lightGallery resets it to the previous value
272+
* @version V2.5.0
271273
*/
272274
resetScrollPosition: boolean;
273275

@@ -316,6 +318,7 @@ export interface LightGalleryCoreSettings {
316318

317319
/**
318320
* Trap focus within the lightGallery
321+
* @version V2.5.0
319322
*/
320323
trapFocus: boolean;
321324

src/plugins/video/lg-video-settings.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ export interface VideoSettings {
6868
/**
6969
* Class name of the videojs theme
7070
* You need to include the theme stylesheet on your document. <a href="https://videojs.com/getting-started/#home-page-themes" target="_blank">More info</a>
71+
* @version V2.5.0
7172
*/
7273
videojsTheme: string;
7374

0 commit comments

Comments
 (0)