vanjuxin-dju / filmstrip.js

0 stars 0 forks source link

Filmstrip.js

Filmstrip.js is a concept of a front-end library, which allows you to create beautiful presentations in a style of filmstrips (diafilms) or diapositive slideshows.

In order to use the library properly, you should create html file with the following structure:

<!DOCTYPE html>
<html>
    <head>
        <meta charset="UTF-8">
        <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
        <title>Presentation title</title>
        <link rel="stylesheet" type="text/css" href="https://github.com/vanjuxin-dju/filmstrip.js/blob/main/filmstrip.css">
    </head>
    <body class="filmstrip"> <!-- add class "filmstrip" -->
        <div class="slides"> <!-- root div element with class "slides" -->
            <section class="slide"> <!-- slide -->
                <div class="slide-content">
                    <h1>Welcome to Filmstrip.js</h1> <!-- slide contents -->
                </div>
            </section>
            <section class="slide">
                <div class="slide-content">
                    <h1>Slide 2</h1>
                </div>
            </section> <!-- you can create as many slides as you want -->
        </div>
        <script src="https://github.com/vanjuxin-dju/filmstrip.js/raw/main/filmstrip.js"></script>
    </body>
</html>

Further information about using this library can be accessed in a wiki section.

Types of presentations

There are 2 main types of presentations supported by this library:

Slide content rules and styles

Slide content can contain such tags as:

ul and ol tags can have no-markers class for list without markers.

All block tags can also have such classes as text-left, text-center, or text-right, depending on how you would like to align your text.

Slide formats

There are the following slide formats:

Slide color themes

There are 41 color themes supported by this library (see wiki section).

Additional features

Perforations

You can simply add a show-perforations class to the root div element (<div class="slides">).

It will decorate your presentation with film perforations provided that your presentation type is a filmstrip and the whole presentation has a specific slide format (not flexible one).

This type of decoration is shown in case there is some free space on the left and right sides (for vertical scrolling) or on the top and the bottom sides (for horizontal scrolling).

The perforations won't be shown if the presentation type is separate diapositive slideshow or some slides have different formats!

Automated slides flipping

You can simply add a data-switch-after="time in seconds" attribute either to the root div element (<div class="slides">) or to a specific slide element (<section class="slide">).

It will automate flipping slides in your presentation.

Slideshow loop

You can simply add a data-loop="loop" attribute to the root div element (<div class="slides">).

It will turn your presentation into a continuous slideshow.

Old film style

You can simply add a show-old-film-style class to the root div element (<div class="slides">).

It will decorate your presentation with scratches like an old age-worn film provided that your presentation has a specific slide format (not flexible one).