1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
|
/**
@license
Copyright (c) 2017 The Polymer Project Authors. All rights reserved.
This code may only be used under the BSD style license found at http://polymer.github.io/LICENSE.txt
The complete set of authors may be found at http://polymer.github.io/AUTHORS.txt
The complete set of contributors may be found at http://polymer.github.io/CONTRIBUTORS.txt
Code distributed by Google as part of the polymer project is also
subject to an additional IP rights grant found at http://polymer.github.io/PATENTS.txt
*/
'use strict';
import documentWait from './document-wait.js';
/**
* @typedef {HTMLStyleElement | {getStyle: function():HTMLStyleElement}}
*/
export let CustomStyleProvider;
const SEEN_MARKER = '__seenByShadyCSS';
const CACHED_STYLE = '__shadyCSSCachedStyle';
/** @type {?function(!HTMLStyleElement)} */
let transformFn = null;
/** @type {?function()} */
let validateFn = null;
/**
This interface is provided to add document-level <style> elements to ShadyCSS for processing.
These styles must be processed by ShadyCSS to simulate ShadowRoot upper-bound encapsulation from outside styles
In addition, these styles may also need to be processed for @apply rules and CSS Custom Properties
To add document-level styles to ShadyCSS, one can call `ShadyCSS.addDocumentStyle(styleElement)` or `ShadyCSS.addDocumentStyle({getStyle: () => styleElement})`
In addition, if the process used to discover document-level styles can be synchronously flushed, one should set `ShadyCSS.documentStyleFlush`.
This function will be called when calculating styles.
An example usage of the document-level styling api can be found in `examples/document-style-lib.js`
@unrestricted
*/
export default class CustomStyleInterface {
constructor() {
/** @type {!Array<!CustomStyleProvider>} */
this['customStyles'] = [];
this['enqueued'] = false;
// NOTE(dfreedm): use quotes here to prevent closure inlining to `function(){}`;
documentWait(() => {
if (window['ShadyCSS']['flushCustomStyles']) {
window['ShadyCSS']['flushCustomStyles']();
}
})
}
/**
* Queue a validation for new custom styles to batch style recalculations
*/
enqueueDocumentValidation() {
if (this['enqueued'] || !validateFn) {
return;
}
this['enqueued'] = true;
documentWait(validateFn);
}
/**
* @param {!HTMLStyleElement} style
*/
addCustomStyle(style) {
if (!style[SEEN_MARKER]) {
style[SEEN_MARKER] = true;
this['customStyles'].push(style);
this.enqueueDocumentValidation();
}
}
/**
* @param {!CustomStyleProvider} customStyle
* @return {HTMLStyleElement}
*/
getStyleForCustomStyle(customStyle) {
if (customStyle[CACHED_STYLE]) {
return customStyle[CACHED_STYLE];
}
let style;
if (customStyle['getStyle']) {
style = customStyle['getStyle']();
} else {
style = customStyle;
}
return style;
}
/**
* @return {!Array<!CustomStyleProvider>}
*/
processStyles() {
const cs = this['customStyles'];
for (let i = 0; i < cs.length; i++) {
const customStyle = cs[i];
if (customStyle[CACHED_STYLE]) {
continue;
}
const style = this.getStyleForCustomStyle(customStyle);
if (style) {
// HTMLImports polyfill may have cloned the style into the main document,
// which is referenced with __appliedElement.
const styleToTransform = /** @type {!HTMLStyleElement} */(style['__appliedElement'] || style);
if (transformFn) {
transformFn(styleToTransform);
}
customStyle[CACHED_STYLE] = styleToTransform;
}
}
return cs;
}
}
/* eslint-disable no-self-assign */
CustomStyleInterface.prototype['addCustomStyle'] = CustomStyleInterface.prototype.addCustomStyle;
CustomStyleInterface.prototype['getStyleForCustomStyle'] = CustomStyleInterface.prototype.getStyleForCustomStyle;
CustomStyleInterface.prototype['processStyles'] = CustomStyleInterface.prototype.processStyles;
/* eslint-enable no-self-assign */
Object.defineProperties(CustomStyleInterface.prototype, {
'transformCallback': {
/** @return {?function(!HTMLStyleElement)} */
get() {
return transformFn;
},
/** @param {?function(!HTMLStyleElement)} fn */
set(fn) {
transformFn = fn;
}
},
'validateCallback': {
/** @return {?function()} */
get() {
return validateFn;
},
/**
* @param {?function()} fn
* @this {CustomStyleInterface}
*/
set(fn) {
let needsEnqueue = false;
if (!validateFn) {
needsEnqueue = true;
}
validateFn = fn;
if (needsEnqueue) {
this.enqueueDocumentValidation();
}
},
}
})
/** @typedef {{
* customStyles: !Array<!CustomStyleProvider>,
* addCustomStyle: function(!CustomStyleProvider),
* getStyleForCustomStyle: function(!CustomStyleProvider): HTMLStyleElement,
* findStyles: function(),
* transformCallback: ?function(!HTMLStyleElement),
* validateCallback: ?function()
* }}
*/
export const CustomStyleInterfaceInterface = {};
|
