{"id":13545247,"url":"https://github.com/TeamWertarbyte/material-auto-rotating-carousel","last_synced_at":"2025-04-02T15:30:59.540Z","repository":{"id":11111550,"uuid":"68394870","full_name":"TeamWertarbyte/material-auto-rotating-carousel","owner":"TeamWertarbyte","description":"Introduce users to your app with this Material-style carousel.","archived":false,"fork":false,"pushed_at":"2023-03-09T12:22:05.000Z","size":6727,"stargazers_count":431,"open_issues_count":30,"forks_count":84,"subscribers_count":16,"default_branch":"master","last_synced_at":"2024-10-14T01:06:11.436Z","etag":null,"topics":["carousel","material","material-design","material-ui","react"],"latest_commit_sha":null,"homepage":"https://mui.wertarbyte.com/#material-auto-rotating-carousel","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TeamWertarbyte.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null},"funding":{"github":["leMaik","saschb2b"]}},"created_at":"2016-09-16T16:09:58.000Z","updated_at":"2024-05-27T06:40:20.000Z","dependencies_parsed_at":"2024-01-14T11:07:18.778Z","dependency_job_id":"885ee392-2bfa-489e-9276-440ec3dd12f4","html_url":"https://github.com/TeamWertarbyte/material-auto-rotating-carousel","commit_stats":{"total_commits":155,"total_committers":19,"mean_commits":8.157894736842104,"dds":0.5354838709677419,"last_synced_commit":"bdd2a9c239e7c934c75fd3e1245e597c2fba6339"},"previous_names":[],"tags_count":28,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TeamWertarbyte%2Fmaterial-auto-rotating-carousel","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TeamWertarbyte%2Fmaterial-auto-rotating-carousel/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TeamWertarbyte%2Fmaterial-auto-rotating-carousel/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TeamWertarbyte%2Fmaterial-auto-rotating-carousel/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TeamWertarbyte","download_url":"https://codeload.github.com/TeamWertarbyte/material-auto-rotating-carousel/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246746932,"owners_count":20827061,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["carousel","material","material-design","material-ui","react"],"created_at":"2024-08-01T11:00:59.651Z","updated_at":"2025-04-02T15:30:59.523Z","avatar_url":"https://github.com/TeamWertarbyte.png","language":"JavaScript","funding_links":["https://github.com/sponsors/leMaik","https://github.com/sponsors/saschb2b"],"categories":["JavaScript","React"],"sub_categories":["Components"],"readme":"# Material AutoRotatingCarousel\n\n[![Build Status](https://travis-ci.org/TeamWertarbyte/material-auto-rotating-carousel.svg?branch=next)](https://travis-ci.org/TeamWertarbyte/material-auto-rotating-carousel)\n[![Standard - JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)\n\nSo 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)!\n\nThis 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.\n\n![Demo](demo.gif)\n\n## Installation\n```shell\nnpm i --save material-auto-rotating-carousel\nnpm i --save react-swipeable-views\n```\n\n**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].\n\n### AutoRotatingCarousel Properties\n\n|Name            |Type        |Default     |Description\n|----------------|------------|------------|--------------------------------\n|autoplay        | `bool`     | `true`     | If `false`, the auto play behavior is disabled.\n|ButtonProps     | `object`   |            | Properties applied to the [Button](https://material-ui.com/api/button/) element.\n|classes         | `object`   |            | Object for customizing the CSS classes.\n|containerStyle  | `object`   |            | Override the inline-styles of the carousel container.\n|hideArrows      | `function` |            | If `true`, the left and right arrows are hidden in the desktop version.\n|interval        | `integer`  | `3000`     | Delay between auto play transitions (in ms).\n|label           | `string`   |            | Button text. If not supplied, the button will be hidden.\n|landscape       | `bool`     |            | If `true`, slide will adjust content for wide mobile screens.\n|mobile          | `bool`     | `false`    | If `true`, the screen width and height is filled.\n|ModalProps      | `object`   |            | Properties applied to the [Modal](https://material-ui.com/api/modal/) element.\n|open            | `bool`     | `false`    | Controls whether the AutoRotatingCarousel is opened or not.\n|onChange        | `function` |            | Fired when the index changed. Returns current index.\n|onClose         | `function` |            | Fired when the gray background of the popup is pressed when it is open.\n|onStart         | `function` |            | Fired when the user clicks the getting started button.\n\n### Slide Properties\n\n|Name                   |Type       |Default      |Description\n|-----------------------|-----------|-------------|--------------------------------\n|classes                | `object`  |             | Object for customizing the CSS classes.\n|landscape              | `bool`    |             | If `true`, slide will adjust content for wide mobile screens (automatically set by `AutoRotatingCarousel`).\n|media*                 | `node`    |             | Object to display in the upper half.\n|mediaBackgroundStyle   | `object`  |             | Override the inline-styles of the media container.\n|mobile                 | `bool`    |             | If `true`, the screen width and height is filled (automatically set by `AutoRotatingCarousel`).\n|style                  | `object`  |             | Override the inline-styles of the slide.\n|subtitle*              | `string`  |             | Subtitle for the slide.\n|title*                 | `string`  |             | Title for the slide.\n\n\\* required property\n\n## Example\n[![Edit material-auto-rotating-carousel example](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/mystifying-varahamihira-dphsr?fontsize=14)\n\n## License\n\nThe files included in this repository are licensed under the MIT license.\n\n[legacy]: https://github.com/TeamWertarbyte/material-auto-rotating-carousel/tree/legacy\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTeamWertarbyte%2Fmaterial-auto-rotating-carousel","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FTeamWertarbyte%2Fmaterial-auto-rotating-carousel","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTeamWertarbyte%2Fmaterial-auto-rotating-carousel/lists"}