Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/TeamWertarbyte/material-auto-rotating-carousel

Introduce users to your app with this Material-style carousel.
https://github.com/TeamWertarbyte/material-auto-rotating-carousel

carousel material material-design material-ui react

Last synced: about 1 month ago
JSON representation

Introduce users to your app with this Material-style carousel.

Host: GitHub
URL: https://github.com/TeamWertarbyte/material-auto-rotating-carousel
Owner: TeamWertarbyte
License: mit
Created: 2016-09-16T16:09:58.000Z (about 8 years ago)
Default Branch: master
Last Pushed: 2023-03-09T12:22:05.000Z (almost 2 years ago)
Last Synced: 2024-10-14T01:06:11.436Z (2 months ago)
Topics: carousel, material, material-design, material-ui, react
Language: JavaScript
Homepage: https://mui.wertarbyte.com/#material-auto-rotating-carousel
Size: 6.42 MB
Stars: 431
Watchers: 16
Forks: 84
Open Issues: 30
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

awesome-material-design - material-auto-rotating-carousel - Material Carousel based on Material UI (React / Components)

README

        # Material AutoRotatingCarousel

[![Build Status](https://travis-ci.org/TeamWertarbyte/material-auto-rotating-carousel.svg?branch=next)](https://travis-ci.org/TeamWertarbyte/material-auto-rotating-carousel)

[![Standard - JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

So you wrote a great app and deployed it and everything. But how do you introduce new users to your app? Well, the Material design guidelines have a solution: Displaying the top benefits in a beautiful [auto-rotating carousel](https://material.io/design/communication/onboarding.html#top-user-benefits-model)!

This project implements such a carousel for [Material-UI](https://material-ui-next.com). Visit [the styleguide](https://mui.wertarbyte.com/#material-auto-rotating-carousel) for an interactive demo.

![Demo](demo.gif)

## Installation

```shell

npm i --save material-auto-rotating-carousel

npm i --save react-swipeable-views

```

**Note:** This is the version for Material-UI 1.0.0 or later. If you are using Material-UI 1.0.0-beta, you should update to the latest version. If you are still using Material-UI 0.x, you can use our [legacy version][legacy].

### AutoRotatingCarousel Properties

|Name            |Type        |Default     |Description

|----------------|------------|------------|--------------------------------

|autoplay        | `bool`     | `true`     | If `false`, the auto play behavior is disabled.

|ButtonProps     | `object`   |            | Properties applied to the [Button](https://material-ui.com/api/button/) element.

|classes         | `object`   |            | Object for customizing the CSS classes.

|containerStyle  | `object`   |            | Override the inline-styles of the carousel container.

|hideArrows      | `function` |            | If `true`, the left and right arrows are hidden in the desktop version.

|interval        | `integer`  | `3000`     | Delay between auto play transitions (in ms).

|label           | `string`   |            | Button text. If not supplied, the button will be hidden.

|landscape       | `bool`     |            | If `true`, slide will adjust content for wide mobile screens.

|mobile          | `bool`     | `false`    | If `true`, the screen width and height is filled.

|ModalProps      | `object`   |            | Properties applied to the [Modal](https://material-ui.com/api/modal/) element.

|open            | `bool`     | `false`    | Controls whether the AutoRotatingCarousel is opened or not.

|onChange        | `function` |            | Fired when the index changed. Returns current index.

|onClose         | `function` |            | Fired when the gray background of the popup is pressed when it is open.

|onStart         | `function` |            | Fired when the user clicks the getting started button.

### Slide Properties

|Name                   |Type       |Default      |Description

|-----------------------|-----------|-------------|--------------------------------

|classes                | `object`  |             | Object for customizing the CSS classes.

|landscape              | `bool`    |             | If `true`, slide will adjust content for wide mobile screens (automatically set by `AutoRotatingCarousel`).

|media*                 | `node`    |             | Object to display in the upper half.

|mediaBackgroundStyle   | `object`  |             | Override the inline-styles of the media container.

|mobile                 | `bool`    |             | If `true`, the screen width and height is filled (automatically set by `AutoRotatingCarousel`).

|style                  | `object`  |             | Override the inline-styles of the slide.

|subtitle*              | `string`  |             | Subtitle for the slide.

|title*                 | `string`  |             | Title for the slide.

\* required property

## Example

[![Edit material-auto-rotating-carousel example](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/mystifying-varahamihira-dphsr?fontsize=14)

## License

The files included in this repository are licensed under the MIT license.

[legacy]: https://github.com/TeamWertarbyte/material-auto-rotating-carousel/tree/legacy