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

Correction to README file #799

Merged
merged 2 commits into from Apr 8, 2019
Merged

Conversation

aarnadlr
Copy link
Contributor

@aarnadlr aarnadlr commented Apr 7, 2019

Hello, there is an error in this documentation. At line 23, reader is advised to add:

@import "@material/ripple/index.scss";

This file does not exist.

User should be advised to add:

@import "@material/ripple/mdc-ripple.scss";

Thank you
a

Hello, there is an error in this documentation. At line 23, reader is advised to add:
```js
@import "@material/ripple/index.scss";
```

This file does not exist.

User should be advised to add:

```js
@import "@material/ripple/mdc-ripple.scss";
```

Thank you
a
@googlebot
Copy link

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here (e.g. I signed it!) and we'll verify it.


What to do if you already signed the CLA

Individual signers
Corporate signers

ℹ️ Googlers: Go here for more info.

@codecov-io
Copy link

codecov-io commented Apr 7, 2019

Codecov Report

Merging #799 into rc0.12.0 will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##           rc0.12.0     #799   +/-   ##
=========================================
  Coverage     95.14%   95.14%           
=========================================
  Files            73       73           
  Lines          2924     2924           
  Branches        449      449           
=========================================
  Hits           2782     2782           
  Misses           46       46           
  Partials         96       96

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 ffd7776...28878cc. Read the comment docs.

… bounded ripple

The current documentation leads the reader to create an unbounded ripple, extending outside the dimensions of the component (even when the `unbounded` prop is removed). The `overflow: hidden` property must be added to render the expected bounded ripple effect. 
Thank you
a
@googlebot
Copy link

CLAs look good, thanks!

ℹ️ Googlers: Go here for more info.

@googlebot googlebot added cla: yes and removed cla: no labels Apr 7, 2019
@aarnadlr
Copy link
Contributor Author

aarnadlr commented Apr 7, 2019

Second commit to this PR:

At Line 30 of README documentation: Advise reader to add overflow: hidden property to .ripple-icon-component to render properly bounded ripple.

The current documentation leads the reader to create an unbounded ripple, extending outside the dimensions of the component (even when the unbounded prop is removed). The overflow: hidden property must be added to render the expected bounded ripple effect.

Thank you
a

Copy link
Contributor

@moog16 moog16 left a comment

Choose a reason for hiding this comment

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

Looks good - thanks for fixing!

@moog16 moog16 merged commit 242203a into material-components:rc0.12.0 Apr 8, 2019
@aarnadlr aarnadlr deleted the patch-1 branch April 11, 2019 01:06
moog16 pushed a commit that referenced this pull request May 1, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants