This repository has been archived by the owner on Jan 13, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
feat(ripple): Annotate mdc-ripple for closure #856
Merged
lynnmercier
merged 2 commits into
material-components:master
from
nckh:feat/closure-ripple
Jun 26, 2017
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -161,6 +161,7 @@ | |
"closureWhitelist": [ | ||
"mdc-animation", | ||
"mdc-base", | ||
"mdc-menu" | ||
"mdc-menu", | ||
"mdc-ripple" | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,94 @@ | ||
/** | ||
* Copyright 2016 Google Inc. All Rights Reserved. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
/* eslint no-unused-vars: [2, {"args": "none"}] */ | ||
|
||
/** | ||
* Adapter for MDC Ripple. Provides an interface for managing | ||
* - classes | ||
* - dom | ||
* - CSS variables | ||
* - position | ||
* - dimensions | ||
* - scroll position | ||
* - event handlers | ||
* - unbounded, active and disabled states | ||
* | ||
* Additionally, provides type information for the adapter to the Closure | ||
* compiler. | ||
* | ||
* Implement this adapter for your framework of choice to delegate updates to | ||
* the component in your framework of choice. See architecture documentation | ||
* for more details. | ||
* https://github.com/material-components/material-components-web/blob/master/docs/architecture.md | ||
* | ||
* @record | ||
*/ | ||
export default class MDCRippleAdapter { | ||
|
||
/** @return {boolean} */ | ||
browserSupportsCssVars() {} | ||
|
||
/** @return {boolean} */ | ||
isUnbounded() {} | ||
|
||
/** @return {boolean} */ | ||
isSurfaceActive() {} | ||
|
||
/** @return {boolean} */ | ||
isSurfaceDisabled() {} | ||
|
||
/** @param {string} className */ | ||
addClass(className) {} | ||
|
||
/** @param {string} className */ | ||
removeClass(className) {} | ||
|
||
/** | ||
* @param {string} evtType | ||
* @param {!Function} handler | ||
*/ | ||
registerInteractionHandler(evtType, handler) {} | ||
|
||
/** | ||
* @param {string} evtType | ||
* @param {!Function} handler | ||
*/ | ||
deregisterInteractionHandler(evtType, handler) {} | ||
|
||
/** | ||
* @param {!Function} handler | ||
*/ | ||
registerResizeHandler(handler) {} | ||
|
||
/** | ||
* @param {!Function} handler | ||
*/ | ||
deregisterResizeHandler(handler) {} | ||
|
||
/** | ||
* @param {string} varName | ||
* @param {?number|string} value | ||
*/ | ||
updateCssVariable(varName, value) {} | ||
|
||
/** @return {!ClientRect} */ | ||
computeBoundingRect() {} | ||
|
||
/** @return {{x: number, y: number}} */ | ||
getWindowPageOffset() {} | ||
|
||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I dont think you actually look at scroll position at all, so remove this
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
getWindowPageOffset? Or did I misunderstand?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh you're totally right. That does make sense