Skip to content

Commit

Permalink
Merge pull request #15468 from storybookjs/fix/broken-links
Browse files Browse the repository at this point in the history
Fix misc broken links
  • Loading branch information
shilman authored Jul 2, 2021
2 parents a41d60e + 90f6c79 commit 2cfdb17
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 4 deletions.
2 changes: 1 addition & 1 deletion addons/links/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,4 +143,4 @@ It accepts all the props the `a` element does, plus `story` and `kind`. It the `
</LinkTo>
```

To implement such a component for another framework, you need to add special handling for `click` event on native `a` element. See [`RoutedLink` sources](https://github.com/storybookjs/storybook/blob/main/addons/links/src/react/components/RoutedLink.js#L20-L24) for reference.
To implement such a component for another framework, you need to add special handling for `click` event on native `a` element. See [`RoutedLink` sources](https://github.com/storybookjs/storybook/blob/main/addons/links/src/react/components/RoutedLink.tsx) for reference.
2 changes: 1 addition & 1 deletion addons/links/src/react/components/RoutedLink.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import React from 'react';

// NOTE: this is a copy of `lib/components/src/navigation/RoutedLink.js`.
// NOTE: this is a copy of `lib/components/src/navigation/RoutedLink.tsx`.
// It's duplicated here because that copy has an explicit dependency on
// React 16.3+, which breaks older versions of React running in the preview.
// The proper DRY solution is to create a new package that doesn't depend
Expand Down
6 changes: 4 additions & 2 deletions lib/ui/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
# Storybook UI
<h1>Storybook UI</h1>

Storybook UI the core UI of [storybook](https://storybook.js.org).
It's a React based UI which you can initialize with a function.
You can configure it by providing a provider API.

## Table of Contents

- [Table of Contents](#table-of-contents)
- [Usage](#usage)
- [API](#api)
- [.setOptions()](#setoptions)
Expand All @@ -20,6 +21,7 @@ You can configure it by providing a provider API.
- [Core API](#core-api)
- [Keyboard Shortcuts](#keyboard-shortcuts)
- [URL Changes](#url-changes)
- [Story Order](#story-order)

## Usage

Expand Down Expand Up @@ -74,7 +76,7 @@ class ReactProvider extends Provider {
handleAPI(api) {
api.setOptions({
// see available options in
// https://github.com/storybookjs/storybook/tree/main/addons/options#getting-started
// https://storybook.js.org/docs/react/configure/features-and-behavior
});
}
}
Expand Down

0 comments on commit 2cfdb17

Please sign in to comment.