Skip to content

Commit

Permalink
bumped to version 2.1.1
Browse files Browse the repository at this point in the history
  • Loading branch information
nixrajput committed Oct 18, 2023
1 parent c99fd70 commit 9ab9b46
Show file tree
Hide file tree
Showing 6 changed files with 162 additions and 61 deletions.
16 changes: 8 additions & 8 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
We as members, contributors, and leaders pledge to participate in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
Expand All @@ -15,7 +15,7 @@ diverse, inclusive, and healthy community.
## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:
community includes:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
Expand All @@ -33,7 +33,7 @@ Examples of unacceptable behavior include:
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
* Other conduct that could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities
Expand All @@ -50,7 +50,7 @@ decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
This Code of Conduct applies within all community spaces and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
Expand All @@ -60,7 +60,7 @@ representative at an online or offline event.

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
nkr.nikhil.nkr@gmail.com.
<nkr.nikhil.nkr@gmail.com>.
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
Expand Down Expand Up @@ -116,13 +116,13 @@ the community.

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
<https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
<https://www.contributor-covenant.org/faq>. Translations are available at
<https://www.contributor-covenant.org/translations>.
63 changes: 63 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# Contributing to the Flutter_Carousel_Widget Package

We appreciate your interest in contributing to the Flutter_Carousel_Widget Package built with Dart and Flutter. By contributing, you help make this project better and more accessible for others. Please take a moment to review the following guidelines to ensure a smooth and collaborative development process.

## Code of Conduct

Please review and adhere to our [Code of Conduct](CODE_OF_CONDUCT.md). We expect all contributors to be respectful, considerate, and inclusive when interacting with the project and its community.

## How to Contribute

Here are the steps to contribute to this project:

1. Fork the Repository: Click the "Fork" button at the top right of this repository to create a copy in your GitHub account.

2. Clone the Repository: Clone your forked repository to your local machine using the following command:

```bash
git clone https://github.com/nixrajput/flutter_carousel_widget.git
```

3. Create a Branch: Create a new branch for your contributions. Make sure to choose a descriptive branch name that reflects the changes you intend to make.

```bash
git checkout -b feature/your-feature-name
```

4. Make Changes: Implement your changes and improvements in your local repository. Follow the coding style and best practices of the project.

5. Test Your Changes: Ensure that your changes do not introduce any errors or regressions. Test the website locally to verify that it functions as expected.

6. Commit Changes: Commit your changes with a clear and descriptive commit message.

```bash
git commit -m "Add feature/fix: Describe your changes here"
```

7. Push Changes: Push your changes to your forked repository on GitHub.

```bash
git push origin feature/your-feature-name
```

8. Create a Pull Request: Go to the original repository on GitHub and click the "New Pull Request" button. Provide a concise description of your changes, why they are necessary, and any relevant information.

9. Review and Collaboration: Contributors and maintainers will review your Pull Request. Be prepared to address any feedback or make additional changes as necessary.

10. Merge: Once your Pull Request is approved and passes all checks, a maintainer will merge it into the main branch. Congratulations, your contribution is now part of the project!

## Development Guidelines

- Follow the project's coding style and guidelines.
- Write clear and concise code with comments where necessary.
- Test your changes thoroughly before submitting a Pull Request.
- Keep Pull Requests focused on a single feature or bug fix.
- Be responsive to feedback and be willing to make improvements as requested.

## Reporting Issues

If you encounter any issues or bugs while using the Flutter_Carousel_Widget Package, please report them on the [Issues](https://github.com/nixrajput/flutter_carousel_widget/issues) page of the repository. Provide as much detail as possible to help us understand and address the problem.

## Thank You

Thank you for contributing to the Flutter_Carousel_Widget Package project. Your contributions help make this project better and more valuable to its users. We appreciate your time and effort in making this project a success!
1 change: 0 additions & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

139 changes: 90 additions & 49 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,31 +14,57 @@ A customizable carousel slider widget in Flutter which supports infinite scrolli
[![GitHub pull requests](https://img.shields.io/github/issues-pr/nixrajput/flutter_carousel_widget?label=Pull+Requests)][pulls]
[![GitHub Licence](https://img.shields.io/github/license/nixrajput/flutter_carousel_widget?label=Licence)][license]

## Table of Contents

- [flutter\_carousel\_widget](#flutter_carousel_widget)
- [Table of Contents](#table-of-contents)
- [Features](#features)
- [Screenshots](#screenshots)
- [Demo](#demo)
- [Installation](#installation)
- [Usage](#usage)
- [Using `FlutterCarousel` Widget](#using-fluttercarousel-widget)
- [Using `ExpandableCarousel` Widget](#using-expandablecarousel-widget)
- [Option Customization](#option-customization)
- [Build item widgets on demand](#build-item-widgets-on-demand)
- [Carousel Controller](#carousel-controller)
- [`CarouselController` methods](#carouselcontroller-methods)
- [`.nextPage({Duration duration, Curve curve})`](#nextpageduration-duration-curve-curve)
- [`.previousPage({Duration duration, Curve curve})`](#previouspageduration-duration-curve-curve)
- [`.jumpToPage(int page)`](#jumptopageint-page)
- [`.animateToPage(int page, {Duration duration, Curve curve})`](#animatetopageint-page-duration-duration-curve-curve)
- [Contributing](#contributing)
- [License](#license)
- [Sponsor Me](#sponsor-me)
- [Connect With Me](#connect-with-me)
- [Activities](#activities)

## Features

* Infinite Scroll
* Custom Child Widget
* Auto Play
* Horizontal and Vertical Alignment
* Pre-built Carousel Indicators
* Custom Indicators
- Infinite Scroll
- Custom Child Widget
- Auto Play
- Horizontal and Vertical Alignment
- Pre-built Carousel Indicators
- Custom Indicators
- Expandable Carousel Widget.
- Auto-sized child support.

## New Features
## Screenshots

* Expandable Carousel Widget.
* Auto-sized child support.
Adding soon...

## Demo

<a href="https://nixrajput.github.io/flutter_carousel_widget" target="_blank">View Demo</a>
[View Demo](https://nixrajput.github.io/flutter_carousel_widget)

## Installation

Add `flutter_carousel_widget` as a dependency in your `pubspec.yaml` file:

```dart
dependencies:
flutter_carousel_widget: "latest_version"
flutter_carousel_widget: ^latest_version
```

And import it:
Expand Down Expand Up @@ -110,38 +136,36 @@ ExpandableCarousel(
FlutterCarousel(
items: items,
options: CarouselOptions(
height: 400.0,
aspectRatio: 16 / 9,
viewportFraction: 1.0,
initialPage: 0,
enableInfiniteScroll: true,
reverse: false,
autoPlay: false,
autoPlayInterval: const Duration(seconds: 2),
autoPlayAnimationDuration: const Duration(milliseconds: 800),
autoPlayCurve: Curves.fastOutSlowIn,
enlargeCenterPage: false,
controller: CarouselController(),
onPageChanged: callbackFunction,
pageSnapping: true,
scrollDirection: Axis.horizontal,
pauseAutoPlayOnTouch: true,
pauseAutoPlayOnManualNavigate: true,
pauseAutoPlayInFiniteScroll: false,
enlargeStrategy: CenterPageEnlargeStrategy.scale,
disableCenter: false,
showIndicator: true,
floatingIndicator = true,
slideIndicator: CircularSlideIndicator(),
height: 400.0,
aspectRatio: 16 / 9,
viewportFraction: 1.0,
initialPage: 0,
enableInfiniteScroll: true,
reverse: false,
autoPlay: false,
autoPlayInterval: const Duration(seconds: 2),
autoPlayAnimationDuration: const Duration(milliseconds: 800),
autoPlayCurve: Curves.fastOutSlowIn,
enlargeCenterPage: false,
controller: CarouselController(),
onPageChanged: callbackFunction,
pageSnapping: true,
scrollDirection: Axis.horizontal,
pauseAutoPlayOnTouch: true,
pauseAutoPlayOnManualNavigate: true,
pauseAutoPlayInFiniteScroll: false,
enlargeStrategy: CenterPageEnlargeStrategy.scale,
disableCenter: false,
showIndicator: true,
floatingIndicator = true,
slideIndicator: CircularSlideIndicator(),
)
)
)
```

### Build item widgets on demand

This method will save memory by building items once it becomes necessary. This way they won't be
built if they're not currently meant to be visible on screen. It can be used to build different
child item widgets related to content or by item index.
This method will save memory by building items once it becomes necessary. This way they won't be built if they're not currently meant to be visible on screen. It can be used to build different child item widgets related to content or by item index.

```dart
FlutterCarousel.builder(
Expand All @@ -165,9 +189,7 @@ ExpandableCarousel.builder(

## Carousel Controller

In order to manually control the pageview's position, you can create your own `CarouselController`,
and pass it to `CarouselSlider`. Then you can use the `CarouselController` instance to manipulate
the position.
In order to manually control the pageview's position, you can create your own `CarouselController`, and pass it to `CarouselSlider`. Then you can use the `CarouselController` instance to manipulate the position.

```dart
class CarouselDemo extends StatelessWidget {
Expand Down Expand Up @@ -215,24 +237,43 @@ Jump to the given page.

Animate to the given page.

## Activities
## Contributing

![Alt](https://repobeats.axiom.co/api/embed/841225761cb31adc7197f30708fd62f1bc210c6c.svg "Repobeats analytics image")
If you would like to contribute to this project, feel free to fork the repository, make your changes, and submit a pull request. Please follow the guidelines in the [CONTRIBUTING.md](CONTRIBUTING.md) file.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Sponsor Me

- By sponsoring my efforts, you're not merely contributing to the development of my projects; you're investing in its growth and sustainability.
- Your support empowers me to dedicate more time and resources to improving the project's features, addressing issues, and ensuring its continued relevance in the rapidly evolving landscape of technology.
- Your sponsorship directly fuels innovation, fosters a vibrant community, and helps maintain the project's high standards of quality. Together, we can shape the future of the projects and make a lasting impact in the open-source community.
- Thank you for considering sponsoring my work!

[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86)](https://github.com/sponsors/nixrajput)

## Connect With Me

[![Instagram: nixrajput](https://img.shields.io/badge/nixrajput-141430?logo=Instagram&logoColor=fff)][instagram]
[![Linkedin: nixrajput](https://img.shields.io/badge/nixrajput-141430?logo=Linkedin&logoColor=fff)][linkedin]
[![GitHub: nixrajput](https://img.shields.io/badge/nixrajput-141430?logo=Github&logoColor=fff)][github]
[![Twitter: nixrajput07](https://img.shields.io/badge/nixrajput07-141430?logo=Twitter&logoColor=fff)][twitter]
[![Facebook: nixrajput07](https://img.shields.io/badge/nixrajput07-141430?logo=Facebook&logoColor=fff)][facebook]
[![GitHub: nixrajput](https://img.shields.io/badge/nixrajput-EFF7F6?logo=GitHub&logoColor=333&link=https://www.github.com/nixrajput)][github]
[![Linkedin: nixrajput](https://img.shields.io/badge/nixrajput-EFF7F6?logo=LinkedIn&logoColor=blue&link=https://www.linkedin.com/in/nixrajput)][linkedin]
[![Instagram: nixrajput](https://img.shields.io/badge/nixrajput-EFF7F6?logo=Instagram&link=https://www.instagram.com/nixrajput)][instagram]
[![Twitter: nixrajput07](https://img.shields.io/badge/nixrajput-EFF7F6?logo=X&logoColor=333&link=https://x.com/nixrajput)][twitter]
[![Telegram: nixrajput](https://img.shields.io/badge/nixrajput-EFF7F6?logo=Telegram&link=https://telegram.me/nixrajput)][telegram]
[![Gmail: nkr.nikhi.nkr@gmail.com](https://img.shields.io/badge/nkr.nikhil.nkr@gmail.com-EFF7F6?logo=Gmail&link=mailto:nkr.nikhil.nkr@gmail.com)][gmail]

## Activities

![Alt](https://repobeats.axiom.co/api/embed/841225761cb31adc7197f30708fd62f1bc210c6c.svg "Repobeats analytics image")

[pub]: https://pub.dev/packages/flutter_carousel_widget
[github]: https://github.com/nixrajput
[facebook]: https://facebook.com/nixrajput07
[telegram]: https://telegram.me/nixrajput
[twitter]: https://twitter.com/nixrajput07
[instagram]: https://instagram.com/nixrajput
[linkedin]: https://linkedin.com/in/nixrajput
[gmail]: mailto:nkr.nikhil.nkr@gmail.com
[releases]: https://github.com/nixrajput/flutter_carousel_widget/releases
[repo]: https://github.com/nixrajput/flutter_carousel_widget
[issues]: https://github.com/nixrajput/flutter_carousel_widget/issues
Expand Down
2 changes: 0 additions & 2 deletions analysis_options.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,8 @@ linter:
- file_names
- hash_and_equals
- implementation_imports
- iterable_contains_unrelated_type
- library_names
- library_prefixes
- list_remove_unrelated_type
- literal_only_boolean_expressions
- no_duplicate_case_values
- non_constant_identifier_names
Expand Down
2 changes: 1 addition & 1 deletion pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: flutter_carousel_widget
description: A customizable carousel slider widget in Flutter which supports infinite scrolling, auto scrolling, custom child widget, custom animations and built-in indicators.

version: 2.1.0
version: 2.1.1

homepage: https://github.com/nixrajput
repository: https://github.com/nixrajput/flutter_carousel_widget
Expand Down

0 comments on commit 9ab9b46

Please sign in to comment.