Compare commits

..

No commits in common. "master" and "0.2.0" have entirely different histories.

14 changed files with 139 additions and 146 deletions

View file

@ -1,14 +0,0 @@
name: Iconica Standard Component CI Workflow
# Workflow Caller version: 2.0.0
on:
pull_request:
workflow_dispatch:
jobs:
call-global-iconica-workflow:
uses: Iconica-Development/.github/.github/workflows/component-ci.yml@master
secrets: inherit
permissions: write-all
with:
subfolder: "." # add optional subfolder to run workflow in

View file

@ -1,14 +0,0 @@
name: Iconica Standard Component Documentation Workflow
# Workflow Caller version: 1.0.0
on:
release:
types: [published]
workflow_dispatch:
jobs:
call-iconica-component-documentation-workflow:
uses: Iconica-Development/.github/.github/workflows/component-documentation.yml@master
secrets: inherit
permissions: write-all

32
.github/workflows/flutter.yml vendored Normal file
View file

@ -0,0 +1,32 @@
name: CI
on:
push:
branches: [ master ]
pull_request:
branches:
- master
- feature/*
- bugfix/*
- hotfix/*
jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/cache@v3
with:
path: |
~/.gradle/wrapper
/opt/hostedtoolcache/flutter
key: ${{ runner.OS }}-flutter-install-cache
- uses: subosito/flutter-action@v2
with:
channel: 'stable'
- name: Flutter pub get
run: flutter pub get
- name: Flutter format
run: flutter format -o none --set-exit-if-changed .
- name: Flutter analyze
run: flutter analyze

4
.gitignore vendored
View file

@ -21,7 +21,3 @@ doc/api/
*.js.map
.idea
# FVM Version Cache
.fvm/
.fvmrc

View file

@ -1,10 +1,3 @@
## 0.3.1
* Added Iconica CI and Iconica Linter
## 0.3.0
* Added option for backwards infinite scrolling and intial page
## 0.1.0
* add opacity as an option to the card transform

View file

@ -1,7 +0,0 @@
* Every sort of widget can be animated as a card.
* For the animation the following properties can be set between animation frames:
this.x = 0,
this.y = 0,
this.angle = 0,
this.scale = 1,
this.opacity = 1.0,

View file

@ -6,9 +6,6 @@ Each card can change its rotation, position and scale when swiping the cards.
![Carousel GIF](carousel.gif)
Figma Design that defines this component (only accessible for Iconica developers): https://www.figma.com/file/4WkjwynOz5wFeFBRqTHPeP/Iconica-Design-System?type=design&node-id=357%3A3335&mode=design&t=XulkAJNPQ32ARxWh-1
## Usage
To use this package, add `carousel` as a dependency in your pubspec.yaml file.

View file

@ -1,9 +1 @@
include: package:flutter_iconica_analysis/analysis_options.yaml
# Possible to overwrite the rules from the package
analyzer:
exclude:
linter:
rules:
include: package:flutter_lints/flutter.yaml

View file

@ -1,7 +1,7 @@
// SPDX-FileCopyrightText: 2022 Iconica
//
// SPDX-License-Identifier: BSD-3-Clause
/// A Flutter package for creating a carousel widget.
library carousel;
export 'package:carousel/src/carousel.dart';

View file

@ -11,8 +11,7 @@ typedef CarouselCardBuilder = Widget Function(BuildContext context, int index);
class Carousel extends StatefulWidget {
/// Animated cards by swiping.
/// Each card can change its rotation, position
/// and scale when swiping the cards.
/// Each card can change its rotation, position and scale when swiping the cards.
/// Transform path can be privided using [transforms]
const Carousel({
required this.transforms,
@ -22,10 +21,8 @@ class Carousel extends StatefulWidget {
this.onPageChanged,
this.alignment = AlignmentDirectional.topStart,
this.onCardClick,
this.initialPage = 0,
this.allowInfiniteScrollingBackwards = false,
super.key,
});
Key? key,
}) : super(key: key);
/// A list of transforms to calculate the position of the card when swiping.
/// Every item in the list is one of the possible card positions.
@ -34,8 +31,7 @@ class Carousel extends StatefulWidget {
/// The index of the transform card which acts as the selected card.
final int selectableCardId;
/// Builder for the card given a [context] and a [index] to
/// identify the right card.
/// Builder for the card given a [context] and a [index] to identify the right card.
final CarouselCardBuilder builder;
/// Called when selected card is changed to the next one.
@ -50,31 +46,16 @@ class Carousel extends StatefulWidget {
/// Size of the pageview used to capture swipe gestures.
final double pageViewHeight;
/// The page to show when first creating the [Carousel].
final int initialPage;
/// Whether to allow infinite scrolling backwards. Defaults to false. If true,
/// this works by using a very large number of pages (10000).
/// Works in conjunction with [initialPage].
final bool allowInfiniteScrollingBackwards;
@override
State<Carousel> createState() => _CarouselState();
}
class _CarouselState extends State<Carousel> {
late PageController _pageController;
final PageController _pageController = PageController(initialPage: 0);
double _currentPage = 0;
@override
void initState() {
_pageController = PageController(
initialPage: widget.allowInfiniteScrollingBackwards
? 10000 + widget.initialPage
: widget.initialPage,
);
_currentPage = _pageController.initialPage.toDouble();
_pageController.addListener(() {
_currentPage = _pageController.page!;
});
@ -88,36 +69,38 @@ class _CarouselState extends State<Carousel> {
}
@override
Widget build(BuildContext context) => Stack(
alignment: widget.alignment,
children: [
AnimatedBuilder(
animation: _pageController,
builder: (context, _) {
var transitionPos = _currentPage % 1;
var index = _currentPage.floor();
var length = widget.transforms.length - 1;
Widget build(BuildContext context) {
return Stack(
alignment: widget.alignment,
children: [
AnimatedBuilder(
animation: _pageController,
builder: (context, _) {
final transitionPos = _currentPage % 1;
final index = _currentPage.floor();
final length = widget.transforms.length - 1;
return Stack(
children: [
for (var i = 0; i < length; i++) ...[
CarouselCard(
cardTransform: widget.transforms[i]
.transform(widget.transforms[i + 1], transitionPos),
child: widget.builder.call(context, index - i),
),
],
return Stack(
children: [
for (var i = 0; i < length; i++) ...[
CarouselCard(
cardTransform: widget.transforms[i]
.transform(widget.transforms[i + 1], transitionPos),
child: widget.builder.call(context, index - i),
),
],
);
},
),
SizedBox(
height: widget.pageViewHeight,
child: PageView.builder(
scrollBehavior: _MouseSwipeOnWeb(),
onPageChanged: widget.onPageChanged,
controller: _pageController,
itemBuilder: (context, index) => Visibility(
],
);
},
),
SizedBox(
height: widget.pageViewHeight,
child: PageView.builder(
scrollBehavior: _MouseSwipeOnWeb(),
onPageChanged: widget.onPageChanged,
controller: _pageController,
itemBuilder: (context, index) {
return Visibility(
visible: false,
maintainState: true,
maintainAnimation: true,
@ -137,11 +120,13 @@ class _CarouselState extends State<Carousel> {
),
],
),
),
),
);
},
),
],
);
),
],
);
}
}
class _MouseSwipeOnWeb extends MaterialScrollBehavior {

View file

@ -28,14 +28,15 @@ class CardTransform {
/// [transitionPos] is a position value of a swipe for example.
/// [other] is the position, scale, rotation
/// which the current [CardTransform] need to be transformed to.
CardTransform transform(CardTransform other, double transitionPos) =>
CardTransform(
x: _transformValue(x, other.x, transitionPos),
y: _transformValue(y, other.y, transitionPos),
angle: _transformValue(angle, other.angle, transitionPos),
scale: _transformValue(scale, other.scale, transitionPos),
opacity: _transformValue(opacity, other.opacity, transitionPos),
);
CardTransform transform(CardTransform other, double transitionPos) {
return CardTransform(
x: _transformValue(x, other.x, transitionPos),
y: _transformValue(y, other.y, transitionPos),
angle: _transformValue(angle, other.angle, transitionPos),
scale: _transformValue(scale, other.scale, transitionPos),
opacity: _transformValue(opacity, other.opacity, transitionPos),
);
}
double _transformValue(double valueA, double valueB, double transformPos) =>
valueA - ((valueA - valueB) * transformPos);

View file

@ -10,24 +10,26 @@ class CarouselCard extends StatelessWidget {
const CarouselCard({
required this.cardTransform,
required this.child,
super.key,
});
Key? key,
}) : super(key: key);
final CardTransform cardTransform;
final Widget child;
@override
Widget build(BuildContext context) => Transform.translate(
offset: Offset(cardTransform.x, cardTransform.y),
child: Transform.rotate(
angle: cardTransform.angle,
child: Transform.scale(
scale: cardTransform.scale,
child: Opacity(
opacity: cardTransform.opacity,
child: child,
),
Widget build(BuildContext context) {
return Transform.translate(
offset: Offset(cardTransform.x, cardTransform.y),
child: Transform.rotate(
angle: cardTransform.angle,
child: Transform.scale(
scale: cardTransform.scale,
child: Opacity(
opacity: cardTransform.opacity,
child: child,
),
),
);
),
);
}
}

View file

@ -1,11 +1,9 @@
name: carousel
description: card carousel
version: 0.3.1
publish_to: https://forgejo.internal.iconica.nl/api/packages/internal/pub
version: 0.2.0
environment:
sdk: ">=3.0.0 <4.0.0"
sdk: ">=2.17.6 <3.0.0"
flutter: ">=1.17.0"
dependencies:
@ -15,9 +13,41 @@ dependencies:
dev_dependencies:
flutter_test:
sdk: flutter
flutter_iconica_analysis:
git:
url: https://github.com/Iconica-Development/flutter_iconica_analysis
ref: 6.0.0
flutter_lints: ^2.0.0
# For information on the generic Dart part of this file, see the
# following page: https://dart.dev/tools/pub/pubspec
# The following section is specific to Flutter packages.
flutter:
# To add assets to your package, add an assets section, like this:
# assets:
# - images/a_dot_burr.jpeg
# - images/a_dot_ham.jpeg
#
# For details regarding assets in packages, see
# https://flutter.dev/assets-and-images/#from-packages
#
# An image asset can refer to one or more resolution-specific "variants", see
# https://flutter.dev/assets-and-images/#resolution-aware
# To add custom fonts to your package, add a fonts section here,
# in this "flutter" section. Each entry in this list should have a
# "family" key with the font family name, and a "fonts" key with a
# list giving the asset and other descriptors for the font. For
# example:
# fonts:
# - family: Schyler
# fonts:
# - asset: fonts/Schyler-Regular.ttf
# - asset: fonts/Schyler-Italic.ttf
# style: italic
# - family: Trajan Pro
# fonts:
# - asset: fonts/TrajanPro.ttf
# - asset: fonts/TrajanPro_Bold.ttf
# weight: 700
#
# For details regarding fonts in packages, see
# https://flutter.dev/custom-fonts/#from-packages