Skip to content

Commit

Permalink
feat(ripple): Annotate mdc-ripple for closure (#856)
Browse files Browse the repository at this point in the history
Resolved #341
  • Loading branch information
nckh authored and lynnmercier committed Jun 27, 2017
1 parent 957d662 commit 44170fb
Show file tree
Hide file tree
Showing 5 changed files with 266 additions and 14 deletions.
3 changes: 2 additions & 1 deletion package.json
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
@@ -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() {}

}

0 comments on commit 44170fb

Please sign in to comment.