https://github.com/tiaanduplessis/next-styled-nprogress

Add NProgress loader between pages in your Next.js App
https://github.com/tiaanduplessis/next-styled-nprogress

next nprogress react styled-components

Last synced: about 2 months ago
JSON representation

Add NProgress loader between pages in your Next.js App

• Host: GitHub
• URL: https://github.com/tiaanduplessis/next-styled-nprogress
• Owner: tiaanduplessis
• License: mit
• Created: 2019-04-13T23:12:50.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-10-25T15:00:03.000Z (about 5 years ago)
• Last Synced: 2024-09-24T03:49:06.061Z (about 2 months ago)
• Topics: next, nprogress, react, styled-components
• Language: JavaScript
• Size: 232 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

# next-styled-nprogress

[![package version](https://img.shields.io/npm/v/next-styled-nprogress.svg?style=flat-square)](https://npmjs.org/package/next-styled-nprogress)

[![package downloads](https://img.shields.io/npm/dm/next-styled-nprogress.svg?style=flat-square)](https://npmjs.org/package/next-styled-nprogress)

[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)

[![package license](https://img.shields.io/npm/l/next-styled-nprogress.svg?style=flat-square)](https://npmjs.org/package/next-styled-nprogress)

[![make a pull request](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)

> Add NProgress loader between pages in your Next.js App

## Table of Contents

- [Install](#install)

- [Usage](#usage)

- [Contribute](#contribute)

- [License](#License)

## Install

This project uses [node](https://nodejs.org) and [npm](https://www.npmjs.com). It requires [Next](https://nextjs.org), [React](https://reactjs.org), [nprogress](https://www.npmjs.com/package/nprogress) and [styled-components](https://www.styled-components.com) as peer dependencies,

```sh

$ npm install next-styled-nprogress

$ # OR

$ yarn add next-styled-nprogress

```

## Usage

In `_app.js`:

```js

import PageNProgress from 'next-styled-nprogress'

class Example extends App {

    // ...

    render () {

        return (

        

            

            

            

        

        )

    }

}

```

`NProgress` can also now be used across site, as the styles are already included:

```js

import React from 'react'

import NProgress from  'nprogress'

const Example = () => {

    const handleClick = () => {

        NProgress.start()

        setTimeout(() => {

            NProgress.done()

        }, 1000)

    }

    return Click me

}

```

## Contribute

1. Fork it and create your feature branch: `git checkout -b my-new-feature`

2. Commit your changes: `git commit -am "Add some feature"`

3. Push to the branch: `git push origin my-new-feature`

4. Submit a pull request

## License

MIT