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.

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

docs(Portal): add Example under Addons Section of Docs #1860

Merged
merged 6 commits into from
Aug 9, 2017

Conversation

alexUXUI
Copy link
Contributor

Documentation Update
Adds Portal Example

Hello, I have added a simple yet functional example of the SUI Portal component. It mainly demonstrates the callback functions that are available through the Portal component API. It is not exhaustive but would provide a good starting point for future iterations.

There is only one problem with the way that this example fits (or does not) fit into the documentation website. Because of the positioning that is baked into of the Portal component, it is rendering underneath the left navigation of the website. I am unsure the best way to resolve as I do not want to add css.

Many thanks to the maintainers and authors of this library. it is a true gem and I would love to be a part of the awesome community around it.

@codecov-io
Copy link

codecov-io commented Jul 12, 2017

Codecov Report

❗ No coverage uploaded for pull request base (master@ae448ae). Click here to learn what that means.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##             master    #1860   +/-   ##
=========================================
  Coverage          ?   99.75%           
=========================================
  Files             ?      145           
  Lines             ?     2474           
  Branches          ?        0           
=========================================
  Hits              ?     2468           
  Misses            ?        6           
  Partials          ?        0

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 ae448ae...86c8712. Read the comment docs.

@alexUXUI
Copy link
Contributor Author

Hmm, I do not see a place to add test coverage to the example I have provided in docs/app/examples. I do see an example test in test/specs/docs/examples-test. I am not sure what I am missing in terms of testing but would like to provide - just need a little guidance.

Copy link
Member

@layershifter layershifter left a comment

Choose a reason for hiding this comment

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

@alexUXUI Please restore files' permissions.

@alexUXUI
Copy link
Contributor Author

@layershifter oh, silly me! Will do now.

@layershifter layershifter changed the title Adds Portal Example under Addons Section of Docs docs(Portal): add Example under Addons Section of Docs Aug 4, 2017
Copy link
Member

@layershifter layershifter left a comment

Choose a reason for hiding this comment

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

@alexUXUI Thanks for PR. I've restored permissions and pushed some style changes @levithomason we're ready for review there

@levithomason
Copy link
Member

Great, thanks!

@levithomason levithomason merged commit 69553ca into Semantic-Org:master Aug 9, 2017
@levithomason
Copy link
Member

Released in semantic-ui-react@0.71.4

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants