Skip to content
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.

Sign up for GitHub

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

[RFR] Fix missing styles in rendered documentation #2474

Merged
merged 1 commit into from
Oct 25, 2018
Merged

[RFR] Fix missing styles in rendered documentation #2474

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/CreateEdit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,7 @@ export const PostEdit = (props) => (

You may want to display additional information on the side of the form. Use the `aside` prop for that, passing the component of your choice:

{% raw %}
```jsx
const Aside = () => (
<div style={{ width: 200, margin: '1em' }}>
Expand All @@ -154,9 +155,11 @@ const PostEdit = props => (
...
</Edit>
```
{% endraw %}

The `aside` component receives the same props as the `Edit` or `Create` child component: `basePath`, `record`, `resource`, and `version`. That means you can display non-editable details of the current record in the aside component:

{% raw %}
```jsx
const Aside = ({ record }) => (
<div style={{ width: 200, margin: '1em' }}>
Expand All @@ -167,6 +170,7 @@ const Aside = ({ record }) => (
</div>
);
```
{% endraw %}

## Prefilling a `<Create>` Record

Expand Down
4 changes: 4 additions & 0 deletions docs/List.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -586,6 +586,7 @@ export const PostList = (props) => (

You may want to display additional information on the side of the list. Use the `aside` prop for that, passing the component of your choice:

{% raw %}
```jsx
const Aside = () => (
<div style={{ width: 200, margin: '1em' }}>
Expand All @@ -601,6 +602,7 @@ const PostList = props => (
...
</List>
```
{% endraw %}

The `aside` component receives the same props as the `List` child component, including the following:

Expand All @@ -619,6 +621,7 @@ The `aside` component receives the same props as the `List` child component, inc

That means you can display additional details of the current list in the aside component:

{% raw %}
```jsx
const Aside = ({ data, ids }) => (
<div style={{ width: 200, margin: '1em' }}>
Expand All @@ -629,6 +632,7 @@ const Aside = ({ data, ids }) => (
</div>
);
```
{% endraw %}

### CSS API

Expand Down
4 changes: 4 additions & 0 deletions docs/Show.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,7 @@ export const PostShow = (props) => (

You may want to display additional information on the side of the resource detail. Use the `aside` prop for that, passing the component of your choice:

{% raw %}
```jsx
const Aside = () => (
<div style={{ width: 200, margin: '1em' }}>
Expand All @@ -135,9 +136,11 @@ const PostShow = props => (
...
</Show>
```
{% endraw %}

The `aside` component receives the same props as the `Show` child component: `basePath`, `record`, `resource`, and `version`. That means you can display secondary details of the current record in the aside component:

{% raw %}
```jsx
const Aside = ({ record }) => (
<div style={{ width: 200, margin: '1em' }}>
Expand All @@ -148,6 +151,7 @@ const Aside = ({ record }) => (
</div>
);
```
{% endraw %}

## The `<ShowGuesser>` component

Expand Down