Improve linkTo documentation #1793
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The linkTo docs are incomplete, references DefinitelyTyped/DefinitelyTyped#19499
Codecov Report
@@ Coverage Diff @@
## master #1793 +/- ##
=======================================
Coverage 21.14% 21.14%
=======================================
Files 252 252
Lines 5693 5693
Branches 687 697 +10
=======================================
Hits 1204 1204
+ Misses 3969 3938 -31
- Partials 520 551 +31
Continue to review full report at Codecov.
|
ndelangen
reviewed
Sep 4, 2017
| @@ -36,12 +36,14 @@ Have a look at the linkTo function: | |||
| import { linkTo } from '@storybook/addon-links' | |||
|
|
|||
| linkTo('Toggle', 'off') | |||
| linkTo(() => 'Toggle', () => 'off') | |||
There was a problem hiding this comment.
I do not understand this example, what does this do?
|
It's the exact same as above - it was introduced in the PR mentioned in the
README, but never formally written down. Basically a callback-based link.
…On 5 Sep. 2017 06:28, "Norbert de Langen" ***@***.***> wrote:
***@***.**** commented on this pull request.
------------------------------
In addons/links/README.md
<#1793 (comment)>:
> @@ -36,12 +36,14 @@ Have a look at the linkTo function:
import { linkTo } from ***@***.***/addon-links'
linkTo('Toggle', 'off')
+linkTo(() => 'Toggle', () => 'off')
I do not understand this example, what does this do?
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
<#1793 (review)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AALeho9Id6CYQy-kaVoEVBdN-9pivgWiks5sfF1VgaJpZM4PLxpr>
.
|
|
Interesting, TIL we have callback based linkTo 👍 |
ndelangen
approved these changes
Sep 5, 2017
usulpro
reviewed
Sep 5, 2017
| @@ -36,12 +36,14 @@ Have a look at the linkTo function: | |||
| import { linkTo } from '@storybook/addon-links' | |||
|
|
|||
| linkTo('Toggle', 'off') | |||
| linkTo(() => 'Toggle', () => 'off') | |||
There was a problem hiding this comment.
shouldn't it be?
linkTo((event) => 'Toggle', (event) => 'off')
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The linkTo docs are incomplete, references DefinitelyTyped/DefinitelyTyped#19499