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

docs: more theming examples #252

Merged
merged 16 commits into from
Sep 25, 2018
Merged

docs: more theming examples #252

merged 16 commits into from
Sep 25, 2018

Conversation

alinais
Copy link
Contributor

@alinais alinais commented Sep 19, 2018

This PR adds more examples for the Theming guide.

@codecov
Copy link

codecov bot commented Sep 21, 2018

Codecov Report

Merging #252 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@          Coverage Diff           @@
##           master    #252   +/-   ##
======================================
  Coverage    91.8%   91.8%           
======================================
  Files          63      63           
  Lines        1171    1171           
  Branches      173     173           
======================================
  Hits         1075    1075           
  Misses         92      92           
  Partials        4       4

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 ef2f951...9082b50. Read the comment docs.

docs/src/views/ThemingExamples.tsx Outdated Show resolved Hide resolved
docs/src/views/ThemingExamples.tsx Outdated Show resolved Hide resolved
docs/src/views/ThemingExamples.tsx Outdated Show resolved Hide resolved
docs/src/views/ThemingExamples.tsx Outdated Show resolved Hide resolved
docs/src/views/ThemingExamples.tsx Outdated Show resolved Hide resolved
</p>

<ol>
<li>
Copy link
Contributor

Choose a reason for hiding this comment

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

seems to be a good place to paste picture @hughreeling was talking about. Probably, for now we could use ul for enumerating these options

docs/src/views/ThemingExamples.tsx Outdated Show resolved Hide resolved

<Header as="h3" content="Nesting Providers" />
<p>
If you need to customize a bigger part of the theme, you can nest the second provider and
Copy link
Contributor

Choose a reason for hiding this comment

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

probably, it would be good to mentioning common use cases where one will need to preserver most of theming aspects, but at the same time achieve one or more of the following

  • tweak some specific styling aspects of existing theme - so to speak, build theme on top of existing one
  • introduce theme changes that will be applied to specific components' subtree only

This will immediately provide reader with an idea whether this section is something she is looking for


export default () => (
<DocPage title="Theming Examples">
<Header as="h2" content="Theming needs" />
Copy link
Contributor

Choose a reason for hiding this comment

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

needs doesn't seem right here. Theming approaches? Theming mechanisms? Theming techniques?

A Theme defines default values and functions to generate variables that will eventually be
used to generate styles for individual components.
</p>
<p>Stardust is intentional in supporting three levels of theming needs:</p>
Copy link
Contributor

Choose a reason for hiding this comment

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

There seem to be four...

docs/src/views/ThemingExamples.tsx Outdated Show resolved Hide resolved
docs/src/views/ThemingExamples.tsx Outdated Show resolved Hide resolved
docs/src/views/ThemingExamples.tsx Outdated Show resolved Hide resolved
docs/src/views/ThemingExamples.tsx Outdated Show resolved Hide resolved
@alinais alinais merged commit 21fa067 into master Sep 25, 2018
@alinais alinais deleted the docs/styles-and-variables branch September 25, 2018 17:08
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.

None yet

5 participants