Skip to content

Commit 9ab9b46

Browse files
committed
bumped to version 2.1.1
1 parent c99fd70 commit 9ab9b46

File tree

6 files changed

+162
-61
lines changed

6 files changed

+162
-61
lines changed

CODE_OF_CONDUCT.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Our Pledge
44

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

1717
Examples of behavior that contributes to a positive environment for our
18-
community include:
18+
community includes:
1919

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

3939
## Enforcement Responsibilities
@@ -50,7 +50,7 @@ decisions when appropriate.
5050

5151
## Scope
5252

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

6161
Instances of abusive, harassing, or otherwise unacceptable behavior may be
6262
reported to the community leaders responsible for enforcement at
63-
63+
6464
All complaints will be reviewed and investigated promptly and fairly.
6565

6666
All community leaders are obligated to respect the privacy and security of the
@@ -116,13 +116,13 @@ the community.
116116

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

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

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

126126
For answers to common questions about this code of conduct, see the FAQ at
127-
https://www.contributor-covenant.org/faq. Translations are available at
128-
https://www.contributor-covenant.org/translations.
127+
<https://www.contributor-covenant.org/faq>. Translations are available at
128+
<https://www.contributor-covenant.org/translations>.

CONTRIBUTING.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# Contributing to the Flutter_Carousel_Widget Package
2+
3+
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.
4+
5+
## Code of Conduct
6+
7+
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.
8+
9+
## How to Contribute
10+
11+
Here are the steps to contribute to this project:
12+
13+
1. Fork the Repository: Click the "Fork" button at the top right of this repository to create a copy in your GitHub account.
14+
15+
2. Clone the Repository: Clone your forked repository to your local machine using the following command:
16+
17+
```bash
18+
git clone https://github.com/nixrajput/flutter_carousel_widget.git
19+
```
20+
21+
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.
22+
23+
```bash
24+
git checkout -b feature/your-feature-name
25+
```
26+
27+
4. Make Changes: Implement your changes and improvements in your local repository. Follow the coding style and best practices of the project.
28+
29+
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.
30+
31+
6. Commit Changes: Commit your changes with a clear and descriptive commit message.
32+
33+
```bash
34+
git commit -m "Add feature/fix: Describe your changes here"
35+
```
36+
37+
7. Push Changes: Push your changes to your forked repository on GitHub.
38+
39+
```bash
40+
git push origin feature/your-feature-name
41+
```
42+
43+
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.
44+
45+
9. Review and Collaboration: Contributors and maintainers will review your Pull Request. Be prepared to address any feedback or make additional changes as necessary.
46+
47+
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!
48+
49+
## Development Guidelines
50+
51+
- Follow the project's coding style and guidelines.
52+
- Write clear and concise code with comments where necessary.
53+
- Test your changes thoroughly before submitting a Pull Request.
54+
- Keep Pull Requests focused on a single feature or bug fix.
55+
- Be responsive to feedback and be willing to make improvements as requested.
56+
57+
## Reporting Issues
58+
59+
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.
60+
61+
## Thank You
62+
63+
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!

LICENSE

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
1919
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
2020
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
2121
SOFTWARE.
22-

README.md

Lines changed: 90 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -14,31 +14,57 @@ A customizable carousel slider widget in Flutter which supports infinite scrolli
1414
[![GitHub pull requests](https://img.shields.io/github/issues-pr/nixrajput/flutter_carousel_widget?label=Pull+Requests)][pulls]
1515
[![GitHub Licence](https://img.shields.io/github/license/nixrajput/flutter_carousel_widget?label=Licence)][license]
1616

17+
## Table of Contents
18+
19+
- [flutter\_carousel\_widget](#flutter_carousel_widget)
20+
- [Table of Contents](#table-of-contents)
21+
- [Features](#features)
22+
- [Screenshots](#screenshots)
23+
- [Demo](#demo)
24+
- [Installation](#installation)
25+
- [Usage](#usage)
26+
- [Using `FlutterCarousel` Widget](#using-fluttercarousel-widget)
27+
- [Using `ExpandableCarousel` Widget](#using-expandablecarousel-widget)
28+
- [Option Customization](#option-customization)
29+
- [Build item widgets on demand](#build-item-widgets-on-demand)
30+
- [Carousel Controller](#carousel-controller)
31+
- [`CarouselController` methods](#carouselcontroller-methods)
32+
- [`.nextPage({Duration duration, Curve curve})`](#nextpageduration-duration-curve-curve)
33+
- [`.previousPage({Duration duration, Curve curve})`](#previouspageduration-duration-curve-curve)
34+
- [`.jumpToPage(int page)`](#jumptopageint-page)
35+
- [`.animateToPage(int page, {Duration duration, Curve curve})`](#animatetopageint-page-duration-duration-curve-curve)
36+
- [Contributing](#contributing)
37+
- [License](#license)
38+
- [Sponsor Me](#sponsor-me)
39+
- [Connect With Me](#connect-with-me)
40+
- [Activities](#activities)
41+
1742
## Features
1843

19-
* Infinite Scroll
20-
* Custom Child Widget
21-
* Auto Play
22-
* Horizontal and Vertical Alignment
23-
* Pre-built Carousel Indicators
24-
* Custom Indicators
44+
- Infinite Scroll
45+
- Custom Child Widget
46+
- Auto Play
47+
- Horizontal and Vertical Alignment
48+
- Pre-built Carousel Indicators
49+
- Custom Indicators
50+
- Expandable Carousel Widget.
51+
- Auto-sized child support.
2552

26-
## New Features
53+
## Screenshots
2754

28-
* Expandable Carousel Widget.
29-
* Auto-sized child support.
55+
Adding soon...
3056

3157
## Demo
3258

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

3561
## Installation
3662

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

3965
```dart
4066
dependencies:
41-
flutter_carousel_widget: "latest_version"
67+
flutter_carousel_widget: ^latest_version
4268
```
4369

4470
And import it:
@@ -110,38 +136,36 @@ ExpandableCarousel(
110136
FlutterCarousel(
111137
items: items,
112138
options: CarouselOptions(
113-
height: 400.0,
114-
aspectRatio: 16 / 9,
115-
viewportFraction: 1.0,
116-
initialPage: 0,
117-
enableInfiniteScroll: true,
118-
reverse: false,
119-
autoPlay: false,
120-
autoPlayInterval: const Duration(seconds: 2),
121-
autoPlayAnimationDuration: const Duration(milliseconds: 800),
122-
autoPlayCurve: Curves.fastOutSlowIn,
123-
enlargeCenterPage: false,
124-
controller: CarouselController(),
125-
onPageChanged: callbackFunction,
126-
pageSnapping: true,
127-
scrollDirection: Axis.horizontal,
128-
pauseAutoPlayOnTouch: true,
129-
pauseAutoPlayOnManualNavigate: true,
130-
pauseAutoPlayInFiniteScroll: false,
131-
enlargeStrategy: CenterPageEnlargeStrategy.scale,
132-
disableCenter: false,
133-
showIndicator: true,
134-
floatingIndicator = true,
135-
slideIndicator: CircularSlideIndicator(),
139+
height: 400.0,
140+
aspectRatio: 16 / 9,
141+
viewportFraction: 1.0,
142+
initialPage: 0,
143+
enableInfiniteScroll: true,
144+
reverse: false,
145+
autoPlay: false,
146+
autoPlayInterval: const Duration(seconds: 2),
147+
autoPlayAnimationDuration: const Duration(milliseconds: 800),
148+
autoPlayCurve: Curves.fastOutSlowIn,
149+
enlargeCenterPage: false,
150+
controller: CarouselController(),
151+
onPageChanged: callbackFunction,
152+
pageSnapping: true,
153+
scrollDirection: Axis.horizontal,
154+
pauseAutoPlayOnTouch: true,
155+
pauseAutoPlayOnManualNavigate: true,
156+
pauseAutoPlayInFiniteScroll: false,
157+
enlargeStrategy: CenterPageEnlargeStrategy.scale,
158+
disableCenter: false,
159+
showIndicator: true,
160+
floatingIndicator = true,
161+
slideIndicator: CircularSlideIndicator(),
136162
)
137-
)
163+
)
138164
```
139165

140166
### Build item widgets on demand
141167

142-
This method will save memory by building items once it becomes necessary. This way they won't be
143-
built if they're not currently meant to be visible on screen. It can be used to build different
144-
child item widgets related to content or by item index.
168+
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.
145169

146170
```dart
147171
FlutterCarousel.builder(
@@ -165,9 +189,7 @@ ExpandableCarousel.builder(
165189

166190
## Carousel Controller
167191

168-
In order to manually control the pageview's position, you can create your own `CarouselController`,
169-
and pass it to `CarouselSlider`. Then you can use the `CarouselController` instance to manipulate
170-
the position.
192+
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.
171193

172194
```dart
173195
class CarouselDemo extends StatelessWidget {
@@ -215,24 +237,43 @@ Jump to the given page.
215237

216238
Animate to the given page.
217239

218-
## Activities
240+
## Contributing
219241

220-
![Alt](https://repobeats.axiom.co/api/embed/841225761cb31adc7197f30708fd62f1bc210c6c.svg "Repobeats analytics image")
242+
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.
243+
244+
## License
245+
246+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
247+
248+
## Sponsor Me
249+
250+
- By sponsoring my efforts, you're not merely contributing to the development of my projects; you're investing in its growth and sustainability.
251+
- 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.
252+
- 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.
253+
- Thank you for considering sponsoring my work!
254+
255+
[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86)](https://github.com/sponsors/nixrajput)
221256

222257
## Connect With Me
223258

224-
[![Instagram: nixrajput](https://img.shields.io/badge/nixrajput-141430?logo=Instagram&logoColor=fff)][instagram]
225-
[![Linkedin: nixrajput](https://img.shields.io/badge/nixrajput-141430?logo=Linkedin&logoColor=fff)][linkedin]
226-
[![GitHub: nixrajput](https://img.shields.io/badge/nixrajput-141430?logo=Github&logoColor=fff)][github]
227-
[![Twitter: nixrajput07](https://img.shields.io/badge/nixrajput07-141430?logo=Twitter&logoColor=fff)][twitter]
228-
[![Facebook: nixrajput07](https://img.shields.io/badge/nixrajput07-141430?logo=Facebook&logoColor=fff)][facebook]
259+
[![GitHub: nixrajput](https://img.shields.io/badge/nixrajput-EFF7F6?logo=GitHub&logoColor=333&link=https://www.github.com/nixrajput)][github]
260+
[![Linkedin: nixrajput](https://img.shields.io/badge/nixrajput-EFF7F6?logo=LinkedIn&logoColor=blue&link=https://www.linkedin.com/in/nixrajput)][linkedin]
261+
[![Instagram: nixrajput](https://img.shields.io/badge/nixrajput-EFF7F6?logo=Instagram&link=https://www.instagram.com/nixrajput)][instagram]
262+
[![Twitter: nixrajput07](https://img.shields.io/badge/nixrajput-EFF7F6?logo=X&logoColor=333&link=https://x.com/nixrajput)][twitter]
263+
[![Telegram: nixrajput](https://img.shields.io/badge/nixrajput-EFF7F6?logo=Telegram&link=https://telegram.me/nixrajput)][telegram]
264+
[![Gmail: [email protected]](https://img.shields.io/badge/[email protected]?logo=Gmail&link=mailto:[email protected])][gmail]
265+
266+
## Activities
267+
268+
![Alt](https://repobeats.axiom.co/api/embed/841225761cb31adc7197f30708fd62f1bc210c6c.svg "Repobeats analytics image")
229269

230270
[pub]: https://pub.dev/packages/flutter_carousel_widget
231271
[github]: https://github.com/nixrajput
232-
[facebook]: https://facebook.com/nixrajput07
272+
[telegram]: https://telegram.me/nixrajput
233273
[twitter]: https://twitter.com/nixrajput07
234274
[instagram]: https://instagram.com/nixrajput
235275
[linkedin]: https://linkedin.com/in/nixrajput
276+
[gmail]: mailto:[email protected]
236277
[releases]: https://github.com/nixrajput/flutter_carousel_widget/releases
237278
[repo]: https://github.com/nixrajput/flutter_carousel_widget
238279
[issues]: https://github.com/nixrajput/flutter_carousel_widget/issues

analysis_options.yaml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,8 @@ linter:
4040
- file_names
4141
- hash_and_equals
4242
- implementation_imports
43-
- iterable_contains_unrelated_type
4443
- library_names
4544
- library_prefixes
46-
- list_remove_unrelated_type
4745
- literal_only_boolean_expressions
4846
- no_duplicate_case_values
4947
- non_constant_identifier_names

pubspec.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name: flutter_carousel_widget
22
description: A customizable carousel slider widget in Flutter which supports infinite scrolling, auto scrolling, custom child widget, custom animations and built-in indicators.
33

4-
version: 2.1.0
4+
version: 2.1.1
55

66
homepage: https://github.com/nixrajput
77
repository: https://github.com/nixrajput/flutter_carousel_widget

0 commit comments

Comments
 (0)