BubbleShowcase
BubbleShowcase 是一個小巧但強大的 Flutter 套件,可讓您突出顯示應用程式中的特定部分,以向使用者解釋或展示您的應用程式新功能。
- 星標
- 39
- 分支
- 26
- 最近推送(UTC)
- 2021年12月8日
- 專案狀態
- 已封存
原始 README
以下為英文專案原文快照,最新內容請造訪 GitHub。
BubbleShowcase
BubbleShowcase is a small but powerful flutter package that allows you to highlight specific parts of your app (to explain them to the user for instance) or to showcase your app new features.
Getting Started
This package is easy to use. Take a look at the following snippet (which is using speech_bubble) :
BubbleShowcase(
bubbleShowcaseId: 'my_bubble_showcase',
bubbleShowcaseVersion: 1,
bubbleSlides: [
RelativeBubbleSlide(
widgetKey: widgetToHighlightKey,
child: RelativeBubbleSlideChild(
direction: AxisDirection.right,
widget: SpeechBubble(
nipLocation: NipLocation.LEFT,
color: Colors.blue,
child: Padding(
padding: EdgeInsets.all(10),
child: Text(
'This is a new cool feature !',
style: TextStyle(color: Colors.white),
),
),
),
),
),
],
child: MyMainWidget(),
);
It creates a BubbleShowcase widget with only one BubbleSlide.
This slide will highlight the widget that holds the key widgetToHighlightKey.
The speech bubble will be placed on the right of the widget.
BubbleShowcase is not limited to highlight a specific widget. You can also highlight a specific part of your app by its coordinates :
BubbleShowcase(
bubbleShowcaseId: 'my_bubble_showcase',
bubbleShowcaseVersion: 1,
bubbleSlides: [
AbsoluteBubbleSlide(
positionCalculator: (size) => Position(
top: 0,
right: 0,
bottom: 0,
left: 0,
),
child: AbsoluteBubbleSlideChild(
positionCalculator: (size) => Position(
top: 0,
left: 0,
),
widget: SpeechBubble(
nipLocation: NipLocation.LEFT,
color: Colors.blue,
child: Padding(
padding: EdgeInsets.all(10),
child: Text(
'This is the top left corner of your app.',
style: TextStyle(color: Colors.white),
),
),
),
),
),
],
child: MyMainWidget(),
);
This will display the speech bubble on the top left corner of your app.
Options
The showcase
The showcase is where everything begins. Let's see the available options :
bubbleShowcaseIdThe showcase identifier. Must be unique across the app as it is used as a saving mean; for instance when the showcase should not be reopened (required).bubbleShowcaseVersionThe showcase version. Increase it when you update the showcase, this allows to redisplay the it to the user ifdoNotReopenOnCloseis set totrue(required).doNotReopenOnCloseWhether this showcase should be reopened once closed.bubbleSlidesThe slides to display (required & must not be empty).childThe widget to display below the slides. It should be your app main widget.counterTextThe current slide counter text.:itargets the current slide number and:ntargets the maximum slide number.showCloseButtonWhether to show a little close button on the top left of the slide.
The slides
The slides is what is highlighting a specific part of your app. There are two main categories of positioning : Absolute and Relative. Here is a little summary :
| Position | Class name | Use case | Specific options |
|---|---|---|---|
| Absolute | AbsoluteBubbleSlide |
You want to position your slide according to a x, y position on the screen and not a specific widget. | positionCalculator The function that calculates the slide position on the screen. |
| Relative | RelativeBubbleSlide |
You want to position your slide according to a specific widget. | widgetKey The global key that the target widget is holding. |
All slides have these options in common :
shapeThe slide shape (available areRectangle,RoundedRectangle,OvalandCirclebut you can add a custom one by extending theShapeclass).boxShadowThe slide box shadow (containing the color, the blur radius, the spread radius, ...).childThe slide child, see below (required).
The slides children
Slides children are what are displayed according to what you are highlighting (it can be a speech bubble for example). The same positioning system is also available for children :
| Position | Class name | Use case | Specific options |
|---|---|---|---|
| Absolute | AbsoluteBubbleSlideChild |
You want to position the child according to a x, y position on the screen and not the highlighted part of the screen. | positionCalculator The function that calculates the child position on the screen. |
| Relative | RelativeBubbleSlideChild |
You want to position the child according to the highlighted zone. | direction Where to position the child compared to the highlighted zone. |
All children have these options in common :
widgetThe widget to display (required).
But you have a lot of other options ! Don't hesitate to check the API Reference or the Github repo.
Contributions
You have a lot of options to contribute to this project ! You can :
分類
使用的依賴
依賴清單 3 項
- flutter
{"sdk":"flutter"} - shared_preferences
>=2.0.0 <3.0.0 - flutter_lints開發依賴
>=1.0.4
如何選擇適合專案的儲存庫?
先依使用情境篩選,再比較專案活躍情況,最後到原始儲存庫確認使用要求。
- 透過儲存庫名稱、作者或描述搜尋,再依技術分類縮小範圍。
- 綜合星標、分支與最近推送比較專案;星標反映社群關注,不保證品質。
- 使用前在 GitHub 確認 README、授權條款與 Issues。
來源與維護
“A repository is the most basic element of GitHub.”
GitHub Docs — About repositories ↗
