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

feat(ripple): Annotate mdc-ripple for closure #856

Merged
merged 2 commits into from
Jun 26, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,7 @@
"closureWhitelist": [
"mdc-animation",
"mdc-base",
"mdc-menu"
"mdc-menu",
"mdc-ripple"
]
}
94 changes: 94 additions & 0 deletions packages/mdc-ripple/adapter.js
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
Copy link
Contributor

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

Copy link
Contributor Author

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?

Copy link
Contributor

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

* - 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() {}

}
Loading