-
Notifications
You must be signed in to change notification settings - Fork 521
docs: 📝 Updated Documentation #522
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
ce498fa to
1275378
Compare
1275378 to
26cf1fc
Compare
4c501b2 to
c200d74
Compare
6c41847 to
d630e4c
Compare
d630e4c to
3865252
Compare
README.md
Outdated
| ```dart | ||
| // This controller will be assigned to respected sctollview. | ||
| final _controller = ScrollController(); | ||
| ## Performance Gains on v5.0.0 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
update this to 5.x.x or 5.0.0+
0f32aab to
6daf451
Compare
| ## Multi-Showcase View | ||
|
|
||
| To show multiple showcases simultaneously, use the same key for multiple showcase widgets: | ||
|
|
||
| ```dart | ||
| // Both will be displayed at the same time | ||
| Showcase( | ||
| key: _multiKey, | ||
| title: 'First Widget', | ||
| description: 'This is the first widget', | ||
| child: Icon(Icons.star), | ||
| ), | ||
| Showcase( | ||
| key: _multiKey, | ||
| title: 'Second Widget', | ||
| description: 'This is the second widget', | ||
| child: Icon(Icons.favorite), | ||
| ), | ||
| ``` | ||
|
|
||
| > **Note:** Auto-scroll does not work with multi-showcase, and properties of the first | ||
| > initialized showcase are used for common settings like barrier tap and colors. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Duplicate keys were never allowed in this package, and now we have enabled it but haven't released it yet. Please use master branch for multiple showcase feature until we release a new version.
6daf451 to
db835ce
Compare

Description
documentation.mdfile for the simform documentation websitereadme.mdto use the documentation website properlyChecklist
fix:,feat:,docs:etc).docsand added dartdoc comments with///.examplesordocs.Breaking Change?