Skip to content
Flutter plugin that allows you to showcase your features on iOS and Android. πŸ‘ŒπŸ”πŸŽ‰
Dart Other
  1. Dart 97.8%
  2. Other 2.2%
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
example - file renamed on example Sep 21, 2019
lib - Removed onFinish Callback as QA is remaining Sep 21, 2019
preview - gif updated Sep 21, 2019
.gitignore Code review (#2) Jun 21, 2019
.metadata Initial commit May 10, 2019
CHANGELOG.md - version name and changelog corrected Sep 21, 2019
CONTRIBUTING.md contribution file. Jun 19, 2019
LICENSE added license Jun 19, 2019
README.md version bump Sep 20, 2019
pubspec.lock Added onFinish() callback Sep 17, 2019
pubspec.yaml - version name and changelog corrected Sep 21, 2019

README.md

ShowCaseView

A Flutter package allows you to Showcase/Highlight your widgets step by step.

It is inspired from Fluttery's Flutter challange.

Preview

The example app running in Android

Installing

  1. Add dependency to pubspec.yaml

    Get the latest version in the 'Installing' tab on pub.dev

dependencies:
    showcaseview: ^0.1.3
  1. Import the package
import 'package:showcaseview/showcaseview.dart';
  1. Adding a ShowCaseWidget widget.
ShowCaseWidget(
  builder: Builder(
    builder : (context) ()=> Somewidget()
  ),
),
  1. Adding a 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,
  ),
),

Some more optional parameters

Showcase(
  key: _two,
  title: 'Profile',
  description: 'Click here to go to your Profile',
  shapeBorder: CircleBorder(),
  showArrow: false,
  slideDuration: Duration(milliseconds: 1500),
  tooltipColor: Colors.blueGrey,
  child: ...,
),
  1. Using a Showcase.withWidget widget.
Showcase.withWidget(
  key: _three,
  cHeight: 80,
  cWidth: 140,
  shapeBorder: CircleBorder(),
  container: Column(
    crossAxisAlignment: CrossAxisAlignment.start,
    children: <Widget>[
      ...
    ],
  ),
  child: ...,
),
  1. Starting the ShowCase
someEvent(){
    ShowCaseWidget.startShowCase(context, [_one, _two, _three]);
}

If you want to start the ShowCaseView as soon as your UI built up then use below code.

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

How to use

Check out the example app in the example directory or the 'Example' tab on pub.dev for a more complete example.

Getting Started

This project is a starting point for a Dart package, a library module containing code that can be shared easily across multiple Flutter or Dart projects.

For help getting started with Flutter, view our online documentation, which offers tutorials, samples, guidance on mobile development, and a full API reference.

You can’t perform that action at this time.