feat: add iconica linter and CI

This commit is contained in:
mike doornenbal 2024-02-02 10:39:41 +01:00
parent 34f9b4143b
commit 7459954bed
9 changed files with 95 additions and 136 deletions

14
.github/workflows/component-ci.yml vendored Normal file
View file

@ -0,0 +1,14 @@
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,32 +0,0 @@
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: dart format -o none --set-exit-if-changed .
- name: Flutter analyze
run: flutter analyze

View file

@ -1,3 +1,7 @@
## 0.3.1
* Added Iconica CI and Iconica Linter
## 0.3.0 ## 0.3.0
* Added option for backwards infinite scrolling and intial page * Added option for backwards infinite scrolling and intial page

View file

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

View file

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

View file

@ -11,7 +11,8 @@ typedef CarouselCardBuilder = Widget Function(BuildContext context, int index);
class Carousel extends StatefulWidget { class Carousel extends StatefulWidget {
/// Animated cards by swiping. /// 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] /// Transform path can be privided using [transforms]
const Carousel({ const Carousel({
required this.transforms, required this.transforms,
@ -23,8 +24,8 @@ class Carousel extends StatefulWidget {
this.onCardClick, this.onCardClick,
this.initialPage = 0, this.initialPage = 0,
this.allowInfiniteScrollingBackwards = false, this.allowInfiniteScrollingBackwards = false,
Key? key, super.key,
}) : super(key: key); });
/// A list of transforms to calculate the position of the card when swiping. /// 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. /// Every item in the list is one of the possible card positions.
@ -33,7 +34,8 @@ class Carousel extends StatefulWidget {
/// The index of the transform card which acts as the selected card. /// The index of the transform card which acts as the selected card.
final int selectableCardId; 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; final CarouselCardBuilder builder;
/// Called when selected card is changed to the next one. /// Called when selected card is changed to the next one.
@ -51,7 +53,9 @@ class Carousel extends StatefulWidget {
/// The page to show when first creating the [Carousel]. /// The page to show when first creating the [Carousel].
final int initialPage; 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]. /// 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; final bool allowInfiniteScrollingBackwards;
@override @override
@ -84,38 +88,36 @@ class _CarouselState extends State<Carousel> {
} }
@override @override
Widget build(BuildContext context) { Widget build(BuildContext context) => Stack(
return Stack( alignment: widget.alignment,
alignment: widget.alignment, children: [
children: [ AnimatedBuilder(
AnimatedBuilder( animation: _pageController,
animation: _pageController, builder: (context, _) {
builder: (context, _) { var transitionPos = _currentPage % 1;
final transitionPos = _currentPage % 1; var index = _currentPage.floor();
final index = _currentPage.floor(); var length = widget.transforms.length - 1;
final length = widget.transforms.length - 1;
return Stack( return Stack(
children: [ children: [
for (var i = 0; i < length; i++) ...[ for (var i = 0; i < length; i++) ...[
CarouselCard( CarouselCard(
cardTransform: widget.transforms[i] cardTransform: widget.transforms[i]
.transform(widget.transforms[i + 1], transitionPos), .transform(widget.transforms[i + 1], transitionPos),
child: widget.builder.call(context, index - i), child: widget.builder.call(context, index - i),
), ),
],
], ],
], );
); },
}, ),
), SizedBox(
SizedBox( height: widget.pageViewHeight,
height: widget.pageViewHeight, child: PageView.builder(
child: PageView.builder( scrollBehavior: _MouseSwipeOnWeb(),
scrollBehavior: _MouseSwipeOnWeb(), onPageChanged: widget.onPageChanged,
onPageChanged: widget.onPageChanged, controller: _pageController,
controller: _pageController, itemBuilder: (context, index) => Visibility(
itemBuilder: (context, index) {
return Visibility(
visible: false, visible: false,
maintainState: true, maintainState: true,
maintainAnimation: true, maintainAnimation: true,
@ -135,13 +137,11 @@ class _CarouselState extends State<Carousel> {
), ),
], ],
), ),
); ),
}, ),
), ),
), ],
], );
);
}
} }
class _MouseSwipeOnWeb extends MaterialScrollBehavior { class _MouseSwipeOnWeb extends MaterialScrollBehavior {

View file

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

View file

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

View file

@ -1,6 +1,6 @@
name: carousel name: carousel
description: card carousel description: card carousel
version: 0.3.0 version: 0.3.1
environment: environment:
sdk: ">=2.17.6 <3.0.0" sdk: ">=2.17.6 <3.0.0"
@ -13,41 +13,9 @@ dependencies:
dev_dependencies: dev_dependencies:
flutter_test: flutter_test:
sdk: flutter sdk: flutter
flutter_lints: ^2.0.0 flutter_iconica_analysis:
git:
url: https://github.com/Iconica-Development/flutter_iconica_analysis
ref: 6.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: 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