Skip to content
This repository was archived by the owner on Mar 4, 2020. It is now read-only.

docs: update theming styles section#274

Merged
levithomason merged 3 commits intomasterfrom
docs/theming
Sep 24, 2018
Merged

docs: update theming styles section#274
levithomason merged 3 commits intomasterfrom
docs/theming

Conversation

@levithomason
Copy link
Member

@levithomason levithomason commented Sep 24, 2018

This PR updates the theming guide:

  • Update styles info to match the flow and pacing of the variables section:
    • show component instance usage via the styles prop on the root
    • show component instance usage via the styles prop on a named slot
    • show multiple component usage via the Provider
    • give info on styling the entire app via the Provider
  • Replace references to "component anatomy" with "component slots".
  • Clean up verbiage and grammar.

Before

image

After

image

@levithomason levithomason changed the title docs: update themeing styles section docs: update theming styles section Sep 24, 2018
You can customize all components in your app by defining component variables on a Provider at
the root of your app.
You can customize component variables for your entire app by defining component variables on a{' '}
<NavLink to="components/provider">Provider</NavLink> at the root of your app.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@codecov
Copy link

codecov bot commented Sep 24, 2018

Codecov Report

Merging #274 into master will decrease coverage by 0.16%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #274      +/-   ##
==========================================
- Coverage   92.36%   92.19%   -0.17%     
==========================================
  Files          63       61       -2     
  Lines        1152     1127      -25     
  Branches      152      168      +16     
==========================================
- Hits         1064     1039      -25     
  Misses         84       84              
  Partials        4        4
Impacted Files Coverage Δ
src/index.ts 100% <0%> (ø) ⬆️
src/components/Attachment/index.ts
src/components/Attachment/Attachment.tsx

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5d842a0...a97d090. Read the comment docs.

value={[
`<Button`,
` icon={{ name: "user", styles: { borderBottom: '4px solid red' } }}`,
` icon={{ name: 'user', styles: { boxShadow: '0 0 0 2px red' } }}`,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

very representative both logically and visually 👍

/>
<p>
Every slot (named part) of every component also accepts <code>styles</code> that are applied
to the root of the slot.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

root -> root element?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indeed, updating...

</div>
)}
/>
<p>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just as a side notice - currently there are no links to the next (if necessary, as there are components sections coming next) and (surely) previous docs page - the ones that are present for the rest of the docs pages. Most probably you already have a plan to address that

Copy link
Contributor

@kuzhelov kuzhelov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@levithomason levithomason merged commit 8dbf8ba into master Sep 24, 2018
@levithomason levithomason deleted the docs/theming branch September 24, 2018 21:27
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants