CSS Variable Namespacing#68846
Conversation
6c27311 to
302644d
Compare
302644d to
e95f942
Compare
| * followed by a separator, such as 'my-app_'. | ||
| * @publicApi | ||
| */ | ||
| export function provideCssVarNamespacing(namespace: string): EnvironmentProviders { |
There was a problem hiding this comment.
Question for reviewer: I'm inclined to automatically add a _ suffic to the provided namespace if it's non-empty and doesn't terminate with a - or _. Any opinions? Might be nice to automatically add the separator.
There was a problem hiding this comment.
I don't feel too strongly, since this should be mostly unobservable by the application.
I wonder if it might be better to be consistent (either always add the suffix or never do) just to reduce unintuitive effects and also reduce bundle size (drop an otherwise unnecessary if statement).
| @Inject(CSS_VAR_NAMESPACE) @Optional() cssVarNamespace: string | null = null, | ||
| ) { | ||
| this.defaultRenderer = new DefaultDomRenderer2(eventManager, doc, ngZone, this.tracingService); | ||
| this.cssVarNamespace = cssVarNamespace ?? ''; |
There was a problem hiding this comment.
Question for reviewer: Rather than falling back to an empty string, I'm inclined to default to the APP_ID. If a user wants to disable prefixing app-wide, they could still provideCssVarNamespacing(''). Thoughts?
There was a problem hiding this comment.
We still need CSS namespacing to be off-by-default right, otherwise this would be a breaking change? So I would think if CSS_VAR_NAMESPACE is not provided, it needs to default to '' just to not break existing apps.
Now we could have provideCssVarNamespacing() (with no argument) default to APP_ID as the namespace. I don't have any objection to that.
| // Validate that the whole `--foo` variable is passed in. | ||
| if (typeof ngDevMode === 'undefined' || ngDevMode) { | ||
| if (!name.startsWith('--')) { | ||
| throw new Error( |
There was a problem hiding this comment.
I think this should be a RuntimeError ?
| * | ||
| * Typically set via {@link provideCssVarNamespacing}. | ||
| */ | ||
| export const CSS_VAR_NAMESPACE = new InjectionToken<string>('CSS_VAR_NAMESPACE'); |
There was a problem hiding this comment.
We can save a few bytes by doing
| export const CSS_VAR_NAMESPACE = new InjectionToken<string>('CSS_VAR_NAMESPACE'); | |
| export const CSS_VAR_NAMESPACE = new InjectionToken<string>(typeof ngDevMode !== 'undefined' && ngDevMode ? 'CSS_VAR_NAMESPACE' : ''); |
There was a problem hiding this comment.
Other suggestion, what if that token had a default factory ?
This was we would skip that optional: true part everywhere it is injected
Adds logic to inject symbols into CSS variables for runtime namespacing. The runtime now replaces instances of `%NS%` with a namespacing variable, limiting reach of CSS variables to the current app. An opt-out syntax of a `--global` prefix allows users to avoid this behavior.
Using `--global-foo` is now prohibited. We suspect these cases will likely be typos of `--global--foo` in the future, so we blanket ban them and direct users to the expected syntax.
Adds support for namespacing css variables in style properties. Behaves as you'd expect following the implementation for stylesheets generally. This change also moves the error message into a util function since we now need to produce the same error in three places.
e95f942 to
5dd7961
Compare
dgp1130
left a comment
There was a problem hiding this comment.
Looks great, no major concerns on my end. Thanks for taking this on @mattrbeck!
| if (!leadingVar && !trailingColon) { | ||
| return match; | ||
| } |
There was a problem hiding this comment.
Question: I assume the need for the leading var or trailing colon is to avoid namespacing situations like .foo--bar {}? Might be worth a comment to call that out more explicitly here.
| result = `--%NS%${varName.substring('--'.length)}`; | ||
| } | ||
|
|
||
| return (leadingVar || '') + result + (trailingColon || ''); |
There was a problem hiding this comment.
Good catch on these edge cases, could definitely seem some of them being problematic if we didn't cover them!
| * followed by a separator, such as 'my-app_'. | ||
| * @publicApi | ||
| */ | ||
| export function provideCssVarNamespacing(namespace: string): EnvironmentProviders { |
There was a problem hiding this comment.
I don't feel too strongly, since this should be mostly unobservable by the application.
I wonder if it might be better to be consistent (either always add the suffix or never do) just to reduce unintuitive effects and also reduce bundle size (drop an otherwise unnecessary if statement).
| @Inject(CSS_VAR_NAMESPACE) @Optional() cssVarNamespace: string | null = null, | ||
| ) { | ||
| this.defaultRenderer = new DefaultDomRenderer2(eventManager, doc, ngZone, this.tracingService); | ||
| this.cssVarNamespace = cssVarNamespace ?? ''; |
There was a problem hiding this comment.
We still need CSS namespacing to be off-by-default right, otherwise this would be a breaking change? So I would think if CSS_VAR_NAMESPACE is not provided, it needs to default to '' just to not break existing apps.
Now we could have provideCssVarNamespacing() (with no argument) default to APP_ID as the namespace. I don't have any objection to that.
| return match; | ||
| } | ||
|
|
||
| if (varName.startsWith('--global-') && !varName.startsWith('--global--')) { |
There was a problem hiding this comment.
Question: We're assuming there are no/few legitimate use cases of --global-foo as an unrelated variable name right?
| if (boundName.startsWith('--global-') && !boundName.startsWith('--global--')) { | ||
| this._reportError(getInvalidCssGlobalError(boundName), boundProp.sourceSpan); | ||
| } | ||
| if (boundName.startsWith('--global--')) { | ||
| boundPropertyName = '--' + boundName.substring('--global--'.length); | ||
| } else { | ||
| boundPropertyName = '--%NS%' + boundName.substring('--'.length); | ||
| } |
There was a problem hiding this comment.
Consider: Is it possible to factor this whole piece of logic into a shared function? I'm a bit worried this could easily diverge if we forget one of them exists.
| if (style.startsWith('--')) { | ||
| style = style.replace('%NS%', this.cssVarNamespace); | ||
| el.style.setProperty(style, value, flags & RendererStyleFlags2.Important ? 'important' : ''); | ||
| } else if (flags & (RendererStyleFlags2.DashCase | RendererStyleFlags2.Important)) { |
There was a problem hiding this comment.
Consider: We can reduce duplication of setProperty by separating the if statements. Same for removeStyle.
| } else if (flags & (RendererStyleFlags2.DashCase | RendererStyleFlags2.Important)) { | |
| if (style.startsWith('--')) { | |
| style = style.replace('%NS%', this.cssVarNamespace); | |
| } | |
| if (flags & (RendererStyleFlags2.DashCase | RendererStyleFlags2.Important)) { |
Superseds #67362. Primary differences are:
--globalprefix, e.g.--global--foo: blue[style.--foo]="'blue'"--global-fooThis adds CSS variable namespacing support to Angular.
This allows multiple apps to coexist on the same page with isolated CSS variables, meaning one can use
color: var(--primary-color);without worrying about accidentally inheriting the primary color of a different app which happens to set it on an ancestor element.To enable this feature, call
provideCssVarNamespacingin yourapp.config.ts. Typically you want to configure this with the same value asAPP_ID, but with an additional separator at the end (a-or_):This only namespaces styles in Angular components (the
stylesorstyleUrlsproperties in@Component). It does not namespace global styles, which are out of scope for this effort.Namespacing does naturally break any JavaScript references to CSS variables, therefore this PR also introduces
CssVarNamespacerwhich allows you to automatically namespace variables based on what is configured in the application.Libraries should consider always using the namespacer when referring to CSS variables, as they may be consumed by applications which enable namespacing.
Namespacing works by having the compiler unconditionally prepend
%NS%to CSS variables (--foo->--%NS%foo) and then at runtime replaces%NS%with a namespace specified byprovideCssVarNamespacing('my-app_')(--%NS%foo->--my-app_foo).Internal bug: b/485672083
Closes #67362 via supersession.