Un package Flutter vous permet de Showcase/Highlight vos widgets étape par étape

Un package Flutter vous permet de Showcase/Highlight vos widgets étape par étape.

Aperçu

Installation

1. Ajouter une dépendance à pubspec.yaml

   Obtenez la dernière version dans l’onglet « Installation » sur pub.dev

dependencies:
    showcaseview: <latest-version>

2. Importer le paquet

import 'package:showcaseview/showcaseview.dart';

3. Ajout d’un ShowCaseWidget widget.

ShowCaseWidget(
  builder: Builder(
    builder : (context)=> Somewidget()
  ),
),

4. Ajout d’un Showcase widget.

GlobalKey _one = GlobalKey();
GlobalKey _two = GlobalKey();
GlobalKey _three = GlobalKey();

...

Showcase(
  key: _one,
  title: 'Menu',
  description: 'Click here to see menu options',
  child: Icon(
    Icons.menu,
    color: Colors.black45,
  ),
),

Quelques paramètres supplémentaires facultatifs

Showcase(
  key: _two,
  title: 'Profile',
  description: 'Click here to go to your Profile',
  disableAnimation: true,
  shapeBorder: CircleBorder(),
  radius: BorderRadius.all(Radius.circular(40)),
  showArrow: false,
  tipBorderRadius: BorderRadius.all(Radius.circular(8)),
  overlayPadding: EdgeInsets.all(5),
  slideDuration: Duration(milliseconds: 1500),
  tooltipColor: Colors.blueGrey,
  blurValue: 2,
  disableDefaultTargetGestures: true,
  initialAnimationCurve: Curves.easeIn,
  initialAnimationDuration: const Duration(milliseconds: 300),
  initialAnimationAlignment: Alignment.center,
  child: ...,
),

5. Utilisant un Showcase.withWidget widget.

Showcase.withWidget(
  key: _three,
  cHeight: 80,
  cWidth: 140,
  shapeBorder: CircleBorder(),
  container: Column(
    crossAxisAlignment: CrossAxisAlignment.start,
    children: <Widget>[
      ...
    ],
  ),
  child: ...,
),

6. Démarrage de la ShowCase

someEvent(){
    ShowCaseWidget.of(context).startShowCase([_one, _two, _three]);
}

7. méthode onFinish pour ShowCase

ShowCaseWidget(
  onFinish: () {
    // Your code goes here
  },
  builder: Builder(
    builder : (context) ()=> Somewidget()
  ),
),

8. Aller au suivant ShowCase

someEvent(){
  ShowCaseWidget.of(context).next();
}

9. Aller au précédent ShowCase

someEvent(){
  ShowCaseWidget.of(context).previous();
}

Si vous souhaitez démarrer la ShowCaseView dès que votre interface utilisateur est créée, utilisez le code ci-dessous.

WidgetsBinding.instance.addPostFrameCallback((_) =>
  ShowCaseWidget.of(context).startShowCase([_one, _two, _three])
);

Si vous souhaitez désactiver l’interaction avec la barrière, réglez disableBarrierInteraction paramètre à vrai.

ShowCaseWidget(
  disableBarrierInteraction: true,
),

Si vous souhaitez désactiver les gestes par défaut du widget cible, définissez disableDefaultTargetGestures paramètre sur true dans Showcase. Remarque : Assurez-vous de fermer la présentation actuelle avec ShowCaseWidget.of(context).dismiss() si vous naviguez vers un autre écran. Ceci sera géré par défaut si disableDefaultTargetGestures est défini sur faux.

ShowCase(
  disableDefaultTargetGestures: true,
),

Comment utiliser

Vérifiez Exemple application dans le Exemple ou l’onglet « Exemple » sur pub.dartlang.org pour un exemple plus complet.

Défilement vers la vitrine active

Le défilement vers la fonctionnalité de présentation active ne fonctionnera pas correctement dans les vues de défilement qui rendent les widgets à la demande (par exemple, ListView, GridView).

Pour faire défiler jusqu’à un widget, il doit être attaché à l’arborescence des widgets. Ainsi, si vous utilisez un scrollview qui rend les widgets à la demande, il est possible que le widget sur lequel la vitrine est appliquée ne soit pas attaché à l’arborescence des widgets. Ainsi, Flutter ne pourra pas faire défiler jusqu’à ce widget.

Donc, si vous souhaitez créer une vue de défilement contenant moins de widgets enfants, préférez utiliser SingleChildScrollView.

Si l’utilisation de SingleChildScrollView n’est pas une option, vous pouvez attribuer un ScrollController à cette vue de défilement et faire défiler manuellement jusqu’à la position où le widget de présentation est rendu. Vous pouvez ajouter ce code dans la méthode onStart de ShowCaseWidget.

Exemple,

// This controller will be assigned to respected sctollview.
final _controller = ScrollController();

ShowCaseWidget(
  onStart: (index, key) {
    if(index == 0) {
      WidgetsBinding.instance.addPostFrameCallback((_) {
       // If showcase widget is at offset 1000 in the listview.
       // If you don't know the exact position of the showcase widget,
       // You can provide nearest possible location.
       // 
       // In this case providing 990 instead of 1000 will work as well.
        _controller.jumpTo(1000);
      });
    }
  },
);

Activer le défilement automatique

Par défaut, le comportement de défilement automatique est désactivé, vous pouvez l’activer en définissant enableAutoScroll drapeau à vrai dans showCaseWidget.

ShowCaseWidget(
  enableAutoScroll: true,
);

Principaux contributeurs

Noter

Nous avons mis à jour la licence de flutter_showcaseview de BSD 2-Clause « Simplified » au MIT.

Licence

MIT License

Copyright (c) 2021 Simform Solutions

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
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.

GitHub

Voir Github