Giter Club home page Giter Club logo

overlay-theme's Introduction

swup 4 is released  🎉  Check out the release notes and upgrade guide.


swup

npm version Bundle size npm downloads Test status License


Swup

Versatile and extensible page transition library for server-rendered websites.

FeaturesDemosPluginsThemesDocumentationDiscussions

Overview

Swup adds page transitions to server-rendered websites. It manages the complete page load lifecycle and smoothly animates between the current and next page. In addition, it offers many other quality-of-life improvements like caching, smart preloading, native browser history and enhanced accessibility.

Make your site feel like a snappy single-page app — without any of the complexity.

Features

  • ✏️ Works out of the box with minimal markup
  • ✨ Auto-detects CSS transitions & animations for perfect timing
  • 🔗 Updates URLs and preserves native browser history
  • 🏓 Manages the scroll position between pages and anchor links
  • 🚀 Uses a cache to speed up subsequent page loads
  • 📡 Offers hooks to customize and extend the page load lifecycle
  • 🔌 Has a powerful plugin system and many official and third-party plugins
  • 🎨 Provides ready-to-go themes to get started quickly

Demos

Explore our interactive demos to see swup in action.

Documentation

Visit our official documentation to learn more.

Plugins

Swup is small by design. Extended features can be added via plugins:

Check out the list of official plugins and third-party integrations.

Themes

Get started quickly with one of three official themes: fade, slide, and overlay.

Examples

Take a look at the interactive demos and sites using swup for more examples.

Having trouble?

If you're having trouble implementing swup, check out the Common Issues section of the docs, look at closed issues or create a new discussion.

Want to Contribute?

We're looking for maintainers!   👀

Become a sponsor on Open Collective or support development through GitHub sponsors.

This project is tested with BrowserStack.

overlay-theme's People

Contributors

daun avatar dependabot[bot] avatar ezadoo avatar gmrchk avatar hirasso avatar lionettiluca avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

overlay-theme's Issues

Multiple Directions [Feature Request]:

Describe the problem 🧐

Is it possible to use multiple directions depending on the link selected with a custom attribute?
Have i missed the info on this and how to apply multiple directions based on navigation paths?

Describe the propsed solution 😎

Custom HTML attribute?

Alternatives considered 🤔

writing additional js to get this to work.

How important is this feature to you? 🧭

I cannot use swup without it

Checked all these? 📚

Typescript support

Describe the problem 🧐

I'm mostly developing with typescript for web apps and I don't wont to activate an option in a tsconfig.json for accepting packages without type declaration, because it will make me forget to install @types/* packages for other packages that don't include it. It also because many devs, are developing in strict mode.

Describe the propsed solution 😎

I think a .d.ts file is sufficient. There is only one file that handles this plugins :)

Alternatives considered 🤔

Making my own declaration file in the projects but not really practical.
Making a fork of this repo and push a possible solution but I'm not really operational on type declaration file :/

How important is this feature to you? 🧭

Would make my life a lot easier

Checked all these? 📚

SwupOverlayTheme no animation

Hi together, after we insert the Theme inside the options:

let options = {
    theme: [
        new SwupOverlayTheme({
        color: '#2D2E82'
        })
    ],
    containers: [
        '#main',
        '#header',
        '#scripts'
    ],
    plugins: [
        new SwupDebugPlugin(),
        new SwupPreloadPlugin(),
        new SwupHeadPlugin(),
        new SwupScriptsPlugin({
            head: true,
            body: true
        }),
        new SwupBodyClassPlugin({
            prefix: 'page-id-'
        }),
        new SwupScrollPlugin({
            doScrollingRightAway: true,
            animateScroll: true,
            scrollFriction: 0.3,
            scrollAcceleration: 0.04,
        }),
        new SwupFormsPlugin({
            formSelector: 'form[data-swup-form]'
        })
    ]
}
const swup = new Swup(options);

The transition from the Theme did not run. Has anyone the same issue?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.