feat(ui): Initial AppearanceProvider support - #3976

Merged
dstaley merged 16 commits into
mainfrom
ds.feat/elements-appearance-prop
Sep 4, 2024
Merged

feat(ui): Initial AppearanceProvider support#3976
dstaley merged 16 commits into
mainfrom
ds.feat/elements-appearance-prop

Conversation

@dstaley

@dstaleydstaley commented Aug 16, 2024

Copy link
Copy Markdown
Member

Description

This PR contains a complete implementation of the appearance prop for the new AIO components. Notable changes from the existing appearance prop include the dropping of arbitrary CSS (such as pseudo elements) and the removal of component-specific styles like appearance={{ elements: { signIn: { ... } } }}.

This PR also contains the following sub-PRs:

Checklist

  • npm test runs as expected.
  • npm run build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

@changeset-bot

changeset-botBot commented Aug 16, 2024

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 1ecaaed

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
NameType
@clerk/uiPatch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

<AppearanceProvider appearance={{ layout: { unsafe_disableDevelopmentModeWarnings: devMode === 'off' } }}>
<style
dangerouslySetInnerHTML={{
__html: css,

Check warning

Code scanning / CodeQL

DOM text reinterpreted as HTML

[DOM text](1) is reinterpreted as HTML without escaping meta-characters. [DOM text](2) is reinterpreted as HTML without escaping meta-characters. [DOM text](3) is reinterpreted as HTML without escaping meta-characters.
@dstaley
dstaley marked this pull request as ready for review August 28, 2024 18:31
/**
* Union of all valid descriptors used throughout the components.
*/
export type DescriptorIdentifier = 'alert' | 'alert__error' | 'alert__warning' | 'alertRoot' | 'alertIcon';

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will definitely want to work out an approach for naming here. I think this was just for testing to start. But ideally we have a convention for underscore vs camelcase etc.

Comment on lines +11 to +37
export const layoutStyle = {
alert: {
className: 'border px-4 py-3',
},
alert__warning: {},
alert__error: {},
alertRoot: {
className: 'flex gap-x-2',
},
alertIcon: {
className: 'mt-px shrink-0 *:size-4',
},
} satisfies ParsedElementsFragment;

export const visualStyle = {
alert: {
className: 'leading-small rounded-md text-base',
},
alert__warning: {
className: 'text-warning bg-warning/[0.06] border-warning/[0.12]',
},
alert__error: {
className: 'text-danger bg-danger/[0.06] border-danger/[0.12]',
},
alertRoot: {},
alertIcon: {},
} satisfies ParsedElementsFragment;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since both the layout and visual styles are needed for each component (I think), have you considered a helper function that'd solve some of the need to have empty objects defined here?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will also have a good amount of these objects for files like the card component which has a good amount of nested components https://github.com/clerk/javascript/blob/main/packages/ui/src/primitives/card.tsx

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The empty objects are a type checking requirement, but after talking with Bryce we decided to move to a runtime validation approach instead. In a future PR, we'll be able to remove these empty objects, and our useAppearance hook will automatically create the empty objects without us needing to specify them.

} from '~/contexts/AppearanceContext';
import * as Icon from './icon';

export const layoutStyle = {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am still not super sold on the layout naming for the based styles. But we can start with it and iterate if we want to change.

Comment threadpackages/ui/src/contexts/AppearanceContext.tsx
Comment on lines -23 to -30
function FirstFactorConnections({
isGlobalLoading,
hasConnection,
}: {
isGlobalLoading: boolean;
hasConnection: boolean;
}) {
const { t } = useLocalizations();

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are these changes meant to be here? 👀

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, I see yes! Alex had a few PRs targeting this branch 👍


export { AppearanceProvider, useAppearance };

if (import.meta.vitest) {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

love that you can test local functions without having to export them!

return result;
}

function mergeAppearance(a: Appearance | null | undefined, b: Appearance | null | undefined): Appearance | null {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might be helpful to outline the merging heuristic in prose in a JSDoc. 👀

@alexcarpenteralexcarpenter left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a solid foundation to build from. I am interested in getting this in sooner than later, and continue iterating on it.

@brkalowbrkalow left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👏 great start!

@dstaley
dstaley merged commit a6a715d into mainSep 4, 2024
@dstaley
dstaley deleted the ds.feat/elements-appearance-prop branch September 4, 2024 19:33
wobsoriano pushed a commit that referenced this pull request Feb 8, 2025
Co-authored-by: Alex Carpenter <im.alexcarpenter@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@dstaley@alexcarpenter@brkalow@github-advanced-security@clerk-cookie
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

feat(ui): Initial AppearanceProvider support - #3976

Merged
dstaley merged 16 commits into
mainfrom
ds.feat/elements-appearance-prop
Sep 4, 2024
Merged

feat(ui): Initial AppearanceProvider support#3976
dstaley merged 16 commits into
mainfrom
ds.feat/elements-appearance-prop

Conversation

@dstaley

@dstaleydstaley commented Aug 16, 2024

Copy link
Copy Markdown
Member

Description

This PR contains a complete implementation of the appearance prop for the new AIO components. Notable changes from the existing appearance prop include the dropping of arbitrary CSS (such as pseudo elements) and the removal of component-specific styles like appearance={{ elements: { signIn: { ... } } }}.

This PR also contains the following sub-PRs:

Checklist

  • npm test runs as expected.
  • npm run build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

@changeset-bot

changeset-botBot commented Aug 16, 2024

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 1ecaaed

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
NameType
@clerk/uiPatch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

<AppearanceProvider appearance={{ layout: { unsafe_disableDevelopmentModeWarnings: devMode === 'off' } }}>
<style
dangerouslySetInnerHTML={{
__html: css,

Check warning

Code scanning / CodeQL

DOM text reinterpreted as HTML

[DOM text](1) is reinterpreted as HTML without escaping meta-characters. [DOM text](2) is reinterpreted as HTML without escaping meta-characters. [DOM text](3) is reinterpreted as HTML without escaping meta-characters.
@dstaley
dstaley marked this pull request as ready for review August 28, 2024 18:31
/**
* Union of all valid descriptors used throughout the components.
*/
export type DescriptorIdentifier = 'alert' | 'alert__error' | 'alert__warning' | 'alertRoot' | 'alertIcon';

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will definitely want to work out an approach for naming here. I think this was just for testing to start. But ideally we have a convention for underscore vs camelcase etc.

Comment on lines +11 to +37
export const layoutStyle = {
alert: {
className: 'border px-4 py-3',
},
alert__warning: {},
alert__error: {},
alertRoot: {
className: 'flex gap-x-2',
},
alertIcon: {
className: 'mt-px shrink-0 *:size-4',
},
} satisfies ParsedElementsFragment;

export const visualStyle = {
alert: {
className: 'leading-small rounded-md text-base',
},
alert__warning: {
className: 'text-warning bg-warning/[0.06] border-warning/[0.12]',
},
alert__error: {
className: 'text-danger bg-danger/[0.06] border-danger/[0.12]',
},
alertRoot: {},
alertIcon: {},
} satisfies ParsedElementsFragment;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since both the layout and visual styles are needed for each component (I think), have you considered a helper function that'd solve some of the need to have empty objects defined here?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will also have a good amount of these objects for files like the card component which has a good amount of nested components https://github.com/clerk/javascript/blob/main/packages/ui/src/primitives/card.tsx

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The empty objects are a type checking requirement, but after talking with Bryce we decided to move to a runtime validation approach instead. In a future PR, we'll be able to remove these empty objects, and our useAppearance hook will automatically create the empty objects without us needing to specify them.

} from '~/contexts/AppearanceContext';
import * as Icon from './icon';

export const layoutStyle = {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am still not super sold on the layout naming for the based styles. But we can start with it and iterate if we want to change.

Comment threadpackages/ui/src/contexts/AppearanceContext.tsx
Comment on lines -23 to -30
function FirstFactorConnections({
isGlobalLoading,
hasConnection,
}: {
isGlobalLoading: boolean;
hasConnection: boolean;
}) {
const { t } = useLocalizations();

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are these changes meant to be here? 👀

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, I see yes! Alex had a few PRs targeting this branch 👍


export { AppearanceProvider, useAppearance };

if (import.meta.vitest) {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

love that you can test local functions without having to export them!

return result;
}

function mergeAppearance(a: Appearance | null | undefined, b: Appearance | null | undefined): Appearance | null {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might be helpful to outline the merging heuristic in prose in a JSDoc. 👀

@alexcarpenteralexcarpenter left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a solid foundation to build from. I am interested in getting this in sooner than later, and continue iterating on it.

@brkalowbrkalow left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👏 great start!

@dstaley
dstaley merged commit a6a715d into mainSep 4, 2024
@dstaley
dstaley deleted the ds.feat/elements-appearance-prop branch September 4, 2024 19:33
wobsoriano pushed a commit that referenced this pull request Feb 8, 2025
Co-authored-by: Alex Carpenter <im.alexcarpenter@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@dstaley@alexcarpenter@brkalow@github-advanced-security@clerk-cookie
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(ui): Initial AppearanceProvider support - #3976

Merged
dstaley merged 16 commits into
mainfrom
ds.feat/elements-appearance-prop
Sep 4, 2024
Merged

feat(ui): Initial AppearanceProvider support#3976
dstaley merged 16 commits into
mainfrom
ds.feat/elements-appearance-prop

Conversation

@dstaley

@dstaleydstaley commented Aug 16, 2024

Copy link
Copy Markdown
Member

Description

This PR contains a complete implementation of the appearance prop for the new AIO components. Notable changes from the existing appearance prop include the dropping of arbitrary CSS (such as pseudo elements) and the removal of component-specific styles like appearance={{ elements: { signIn: { ... } } }}.

This PR also contains the following sub-PRs:

Checklist

  • npm test runs as expected.
  • npm run build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

@changeset-bot

changeset-botBot commented Aug 16, 2024

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 1ecaaed

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
NameType
@clerk/uiPatch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

<AppearanceProvider appearance={{ layout: { unsafe_disableDevelopmentModeWarnings: devMode === 'off' } }}>
<style
dangerouslySetInnerHTML={{
__html: css,

Check warning

Code scanning / CodeQL

DOM text reinterpreted as HTML

[DOM text](1) is reinterpreted as HTML without escaping meta-characters. [DOM text](2) is reinterpreted as HTML without escaping meta-characters. [DOM text](3) is reinterpreted as HTML without escaping meta-characters.
@dstaley
dstaley marked this pull request as ready for review August 28, 2024 18:31
/**
* Union of all valid descriptors used throughout the components.
*/
export type DescriptorIdentifier = 'alert' | 'alert__error' | 'alert__warning' | 'alertRoot' | 'alertIcon';

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will definitely want to work out an approach for naming here. I think this was just for testing to start. But ideally we have a convention for underscore vs camelcase etc.

Comment on lines +11 to +37
export const layoutStyle = {
alert: {
className: 'border px-4 py-3',
},
alert__warning: {},
alert__error: {},
alertRoot: {
className: 'flex gap-x-2',
},
alertIcon: {
className: 'mt-px shrink-0 *:size-4',
},
} satisfies ParsedElementsFragment;

export const visualStyle = {
alert: {
className: 'leading-small rounded-md text-base',
},
alert__warning: {
className: 'text-warning bg-warning/[0.06] border-warning/[0.12]',
},
alert__error: {
className: 'text-danger bg-danger/[0.06] border-danger/[0.12]',
},
alertRoot: {},
alertIcon: {},
} satisfies ParsedElementsFragment;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since both the layout and visual styles are needed for each component (I think), have you considered a helper function that'd solve some of the need to have empty objects defined here?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will also have a good amount of these objects for files like the card component which has a good amount of nested components https://github.com/clerk/javascript/blob/main/packages/ui/src/primitives/card.tsx

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The empty objects are a type checking requirement, but after talking with Bryce we decided to move to a runtime validation approach instead. In a future PR, we'll be able to remove these empty objects, and our useAppearance hook will automatically create the empty objects without us needing to specify them.

} from '~/contexts/AppearanceContext';
import * as Icon from './icon';

export const layoutStyle = {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am still not super sold on the layout naming for the based styles. But we can start with it and iterate if we want to change.

Comment threadpackages/ui/src/contexts/AppearanceContext.tsx
Comment on lines -23 to -30
function FirstFactorConnections({
isGlobalLoading,
hasConnection,
}: {
isGlobalLoading: boolean;
hasConnection: boolean;
}) {
const { t } = useLocalizations();

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are these changes meant to be here? 👀

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, I see yes! Alex had a few PRs targeting this branch 👍


export { AppearanceProvider, useAppearance };

if (import.meta.vitest) {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

love that you can test local functions without having to export them!

return result;
}

function mergeAppearance(a: Appearance | null | undefined, b: Appearance | null | undefined): Appearance | null {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might be helpful to outline the merging heuristic in prose in a JSDoc. 👀

@alexcarpenteralexcarpenter left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a solid foundation to build from. I am interested in getting this in sooner than later, and continue iterating on it.

@brkalowbrkalow left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👏 great start!

@dstaley
dstaley merged commit a6a715d into mainSep 4, 2024
@dstaley
dstaley deleted the ds.feat/elements-appearance-prop branch September 4, 2024 19:33
wobsoriano pushed a commit that referenced this pull request Feb 8, 2025
Co-authored-by: Alex Carpenter <im.alexcarpenter@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@dstaley@alexcarpenter@brkalow@github-advanced-security@clerk-cookie
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(ui): Initial AppearanceProvider support - #3976

Merged
dstaley merged 16 commits into
mainfrom
ds.feat/elements-appearance-prop
Sep 4, 2024
Merged

feat(ui): Initial AppearanceProvider support#3976
dstaley merged 16 commits into
mainfrom
ds.feat/elements-appearance-prop

Conversation

@dstaley

@dstaleydstaley commented Aug 16, 2024

Copy link
Copy Markdown
Member

Description

This PR contains a complete implementation of the appearance prop for the new AIO components. Notable changes from the existing appearance prop include the dropping of arbitrary CSS (such as pseudo elements) and the removal of component-specific styles like appearance={{ elements: { signIn: { ... } } }}.

This PR also contains the following sub-PRs:

Checklist

  • npm test runs as expected.
  • npm run build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

@changeset-bot

changeset-botBot commented Aug 16, 2024

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 1ecaaed

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
NameType
@clerk/uiPatch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

<AppearanceProvider appearance={{ layout: { unsafe_disableDevelopmentModeWarnings: devMode === 'off' } }}>
<style
dangerouslySetInnerHTML={{
__html: css,

Check warning

Code scanning / CodeQL

DOM text reinterpreted as HTML

[DOM text](1) is reinterpreted as HTML without escaping meta-characters. [DOM text](2) is reinterpreted as HTML without escaping meta-characters. [DOM text](3) is reinterpreted as HTML without escaping meta-characters.
@dstaley
dstaley marked this pull request as ready for review August 28, 2024 18:31
/**
* Union of all valid descriptors used throughout the components.
*/
export type DescriptorIdentifier = 'alert' | 'alert__error' | 'alert__warning' | 'alertRoot' | 'alertIcon';

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will definitely want to work out an approach for naming here. I think this was just for testing to start. But ideally we have a convention for underscore vs camelcase etc.

Comment on lines +11 to +37
export const layoutStyle = {
alert: {
className: 'border px-4 py-3',
},
alert__warning: {},
alert__error: {},
alertRoot: {
className: 'flex gap-x-2',
},
alertIcon: {
className: 'mt-px shrink-0 *:size-4',
},
} satisfies ParsedElementsFragment;

export const visualStyle = {
alert: {
className: 'leading-small rounded-md text-base',
},
alert__warning: {
className: 'text-warning bg-warning/[0.06] border-warning/[0.12]',
},
alert__error: {
className: 'text-danger bg-danger/[0.06] border-danger/[0.12]',
},
alertRoot: {},
alertIcon: {},
} satisfies ParsedElementsFragment;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since both the layout and visual styles are needed for each component (I think), have you considered a helper function that'd solve some of the need to have empty objects defined here?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will also have a good amount of these objects for files like the card component which has a good amount of nested components https://github.com/clerk/javascript/blob/main/packages/ui/src/primitives/card.tsx

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The empty objects are a type checking requirement, but after talking with Bryce we decided to move to a runtime validation approach instead. In a future PR, we'll be able to remove these empty objects, and our useAppearance hook will automatically create the empty objects without us needing to specify them.

} from '~/contexts/AppearanceContext';
import * as Icon from './icon';

export const layoutStyle = {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am still not super sold on the layout naming for the based styles. But we can start with it and iterate if we want to change.

Comment threadpackages/ui/src/contexts/AppearanceContext.tsx
Comment on lines -23 to -30
function FirstFactorConnections({
isGlobalLoading,
hasConnection,
}: {
isGlobalLoading: boolean;
hasConnection: boolean;
}) {
const { t } = useLocalizations();

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are these changes meant to be here? 👀

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, I see yes! Alex had a few PRs targeting this branch 👍


export { AppearanceProvider, useAppearance };

if (import.meta.vitest) {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

love that you can test local functions without having to export them!

return result;
}

function mergeAppearance(a: Appearance | null | undefined, b: Appearance | null | undefined): Appearance | null {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might be helpful to outline the merging heuristic in prose in a JSDoc. 👀

@alexcarpenteralexcarpenter left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a solid foundation to build from. I am interested in getting this in sooner than later, and continue iterating on it.

@brkalowbrkalow left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👏 great start!

@dstaley
dstaley merged commit a6a715d into mainSep 4, 2024
@dstaley
dstaley deleted the ds.feat/elements-appearance-prop branch September 4, 2024 19:33
wobsoriano pushed a commit that referenced this pull request Feb 8, 2025
Co-authored-by: Alex Carpenter <im.alexcarpenter@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@dstaley@alexcarpenter@brkalow@github-advanced-security@clerk-cookie
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

feat(ui): Initial AppearanceProvider support - #3976

Merged
dstaley merged 16 commits into
mainfrom
ds.feat/elements-appearance-prop
Sep 4, 2024
Merged

feat(ui): Initial AppearanceProvider support#3976
dstaley merged 16 commits into
mainfrom
ds.feat/elements-appearance-prop

Conversation

@dstaley

@dstaleydstaley commented Aug 16, 2024

Copy link
Copy Markdown
Member

Description

This PR contains a complete implementation of the appearance prop for the new AIO components. Notable changes from the existing appearance prop include the dropping of arbitrary CSS (such as pseudo elements) and the removal of component-specific styles like appearance={{ elements: { signIn: { ... } } }}.

This PR also contains the following sub-PRs:

Checklist

  • npm test runs as expected.
  • npm run build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

@changeset-bot

changeset-botBot commented Aug 16, 2024

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 1ecaaed

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
NameType
@clerk/uiPatch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

<AppearanceProvider appearance={{ layout: { unsafe_disableDevelopmentModeWarnings: devMode === 'off' } }}>
<style
dangerouslySetInnerHTML={{
__html: css,

Check warning

Code scanning / CodeQL

DOM text reinterpreted as HTML

[DOM text](1) is reinterpreted as HTML without escaping meta-characters. [DOM text](2) is reinterpreted as HTML without escaping meta-characters. [DOM text](3) is reinterpreted as HTML without escaping meta-characters.
@dstaley
dstaley marked this pull request as ready for review August 28, 2024 18:31
/**
* Union of all valid descriptors used throughout the components.
*/
export type DescriptorIdentifier = 'alert' | 'alert__error' | 'alert__warning' | 'alertRoot' | 'alertIcon';

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will definitely want to work out an approach for naming here. I think this was just for testing to start. But ideally we have a convention for underscore vs camelcase etc.

Comment on lines +11 to +37
export const layoutStyle = {
alert: {
className: 'border px-4 py-3',
},
alert__warning: {},
alert__error: {},
alertRoot: {
className: 'flex gap-x-2',
},
alertIcon: {
className: 'mt-px shrink-0 *:size-4',
},
} satisfies ParsedElementsFragment;

export const visualStyle = {
alert: {
className: 'leading-small rounded-md text-base',
},
alert__warning: {
className: 'text-warning bg-warning/[0.06] border-warning/[0.12]',
},
alert__error: {
className: 'text-danger bg-danger/[0.06] border-danger/[0.12]',
},
alertRoot: {},
alertIcon: {},
} satisfies ParsedElementsFragment;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since both the layout and visual styles are needed for each component (I think), have you considered a helper function that'd solve some of the need to have empty objects defined here?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will also have a good amount of these objects for files like the card component which has a good amount of nested components https://github.com/clerk/javascript/blob/main/packages/ui/src/primitives/card.tsx

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The empty objects are a type checking requirement, but after talking with Bryce we decided to move to a runtime validation approach instead. In a future PR, we'll be able to remove these empty objects, and our useAppearance hook will automatically create the empty objects without us needing to specify them.

} from '~/contexts/AppearanceContext';
import * as Icon from './icon';

export const layoutStyle = {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am still not super sold on the layout naming for the based styles. But we can start with it and iterate if we want to change.

Comment threadpackages/ui/src/contexts/AppearanceContext.tsx
Comment on lines -23 to -30
function FirstFactorConnections({
isGlobalLoading,
hasConnection,
}: {
isGlobalLoading: boolean;
hasConnection: boolean;
}) {
const { t } = useLocalizations();

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are these changes meant to be here? 👀

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, I see yes! Alex had a few PRs targeting this branch 👍


export { AppearanceProvider, useAppearance };

if (import.meta.vitest) {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

love that you can test local functions without having to export them!

return result;
}

function mergeAppearance(a: Appearance | null | undefined, b: Appearance | null | undefined): Appearance | null {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might be helpful to outline the merging heuristic in prose in a JSDoc. 👀

@alexcarpenteralexcarpenter left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a solid foundation to build from. I am interested in getting this in sooner than later, and continue iterating on it.

@brkalowbrkalow left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👏 great start!

@dstaley
dstaley merged commit a6a715d into mainSep 4, 2024
@dstaley
dstaley deleted the ds.feat/elements-appearance-prop branch September 4, 2024 19:33
wobsoriano pushed a commit that referenced this pull request Feb 8, 2025
Co-authored-by: Alex Carpenter <im.alexcarpenter@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@dstaley@alexcarpenter@brkalow@github-advanced-security@clerk-cookie
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(ui): Initial AppearanceProvider support - #3976

Merged
dstaley merged 16 commits into
mainfrom
ds.feat/elements-appearance-prop
Sep 4, 2024
Merged

feat(ui): Initial AppearanceProvider support#3976
dstaley merged 16 commits into
mainfrom
ds.feat/elements-appearance-prop

Conversation

@dstaley

@dstaleydstaley commented Aug 16, 2024

Copy link
Copy Markdown
Member

Description

This PR contains a complete implementation of the appearance prop for the new AIO components. Notable changes from the existing appearance prop include the dropping of arbitrary CSS (such as pseudo elements) and the removal of component-specific styles like appearance={{ elements: { signIn: { ... } } }}.

This PR also contains the following sub-PRs:

Checklist

  • npm test runs as expected.
  • npm run build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

@changeset-bot

changeset-botBot commented Aug 16, 2024

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 1ecaaed

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
NameType
@clerk/uiPatch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

<AppearanceProvider appearance={{ layout: { unsafe_disableDevelopmentModeWarnings: devMode === 'off' } }}>
<style
dangerouslySetInnerHTML={{
__html: css,

Check warning

Code scanning / CodeQL

DOM text reinterpreted as HTML

[DOM text](1) is reinterpreted as HTML without escaping meta-characters. [DOM text](2) is reinterpreted as HTML without escaping meta-characters. [DOM text](3) is reinterpreted as HTML without escaping meta-characters.
@dstaley
dstaley marked this pull request as ready for review August 28, 2024 18:31
/**
* Union of all valid descriptors used throughout the components.
*/
export type DescriptorIdentifier = 'alert' | 'alert__error' | 'alert__warning' | 'alertRoot' | 'alertIcon';

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will definitely want to work out an approach for naming here. I think this was just for testing to start. But ideally we have a convention for underscore vs camelcase etc.

Comment on lines +11 to +37
export const layoutStyle = {
alert: {
className: 'border px-4 py-3',
},
alert__warning: {},
alert__error: {},
alertRoot: {
className: 'flex gap-x-2',
},
alertIcon: {
className: 'mt-px shrink-0 *:size-4',
},
} satisfies ParsedElementsFragment;

export const visualStyle = {
alert: {
className: 'leading-small rounded-md text-base',
},
alert__warning: {
className: 'text-warning bg-warning/[0.06] border-warning/[0.12]',
},
alert__error: {
className: 'text-danger bg-danger/[0.06] border-danger/[0.12]',
},
alertRoot: {},
alertIcon: {},
} satisfies ParsedElementsFragment;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since both the layout and visual styles are needed for each component (I think), have you considered a helper function that'd solve some of the need to have empty objects defined here?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will also have a good amount of these objects for files like the card component which has a good amount of nested components https://github.com/clerk/javascript/blob/main/packages/ui/src/primitives/card.tsx

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The empty objects are a type checking requirement, but after talking with Bryce we decided to move to a runtime validation approach instead. In a future PR, we'll be able to remove these empty objects, and our useAppearance hook will automatically create the empty objects without us needing to specify them.

} from '~/contexts/AppearanceContext';
import * as Icon from './icon';

export const layoutStyle = {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am still not super sold on the layout naming for the based styles. But we can start with it and iterate if we want to change.

Comment threadpackages/ui/src/contexts/AppearanceContext.tsx
Comment on lines -23 to -30
function FirstFactorConnections({
isGlobalLoading,
hasConnection,
}: {
isGlobalLoading: boolean;
hasConnection: boolean;
}) {
const { t } = useLocalizations();

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are these changes meant to be here? 👀

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, I see yes! Alex had a few PRs targeting this branch 👍


export { AppearanceProvider, useAppearance };

if (import.meta.vitest) {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

love that you can test local functions without having to export them!

return result;
}

function mergeAppearance(a: Appearance | null | undefined, b: Appearance | null | undefined): Appearance | null {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might be helpful to outline the merging heuristic in prose in a JSDoc. 👀

@alexcarpenteralexcarpenter left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a solid foundation to build from. I am interested in getting this in sooner than later, and continue iterating on it.

@brkalowbrkalow left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👏 great start!

@dstaley
dstaley merged commit a6a715d into mainSep 4, 2024
@dstaley
dstaley deleted the ds.feat/elements-appearance-prop branch September 4, 2024 19:33
wobsoriano pushed a commit that referenced this pull request Feb 8, 2025
Co-authored-by: Alex Carpenter <im.alexcarpenter@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@dstaley@alexcarpenter@brkalow@github-advanced-security@clerk-cookie
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(ui): Initial AppearanceProvider support - #3976

Merged
dstaley merged 16 commits into
mainfrom
ds.feat/elements-appearance-prop
Sep 4, 2024
Merged

feat(ui): Initial AppearanceProvider support#3976
dstaley merged 16 commits into
mainfrom
ds.feat/elements-appearance-prop

Conversation

@dstaley

@dstaleydstaley commented Aug 16, 2024

Copy link
Copy Markdown
Member

Description

This PR contains a complete implementation of the appearance prop for the new AIO components. Notable changes from the existing appearance prop include the dropping of arbitrary CSS (such as pseudo elements) and the removal of component-specific styles like appearance={{ elements: { signIn: { ... } } }}.

This PR also contains the following sub-PRs:

Checklist

  • npm test runs as expected.
  • npm run build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

@changeset-bot

changeset-botBot commented Aug 16, 2024

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 1ecaaed

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
NameType
@clerk/uiPatch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

<AppearanceProvider appearance={{ layout: { unsafe_disableDevelopmentModeWarnings: devMode === 'off' } }}>
<style
dangerouslySetInnerHTML={{
__html: css,

Check warning

Code scanning / CodeQL

DOM text reinterpreted as HTML

[DOM text](1) is reinterpreted as HTML without escaping meta-characters. [DOM text](2) is reinterpreted as HTML without escaping meta-characters. [DOM text](3) is reinterpreted as HTML without escaping meta-characters.
@dstaley
dstaley marked this pull request as ready for review August 28, 2024 18:31
/**
* Union of all valid descriptors used throughout the components.
*/
export type DescriptorIdentifier = 'alert' | 'alert__error' | 'alert__warning' | 'alertRoot' | 'alertIcon';

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will definitely want to work out an approach for naming here. I think this was just for testing to start. But ideally we have a convention for underscore vs camelcase etc.

Comment on lines +11 to +37
export const layoutStyle = {
alert: {
className: 'border px-4 py-3',
},
alert__warning: {},
alert__error: {},
alertRoot: {
className: 'flex gap-x-2',
},
alertIcon: {
className: 'mt-px shrink-0 *:size-4',
},
} satisfies ParsedElementsFragment;

export const visualStyle = {
alert: {
className: 'leading-small rounded-md text-base',
},
alert__warning: {
className: 'text-warning bg-warning/[0.06] border-warning/[0.12]',
},
alert__error: {
className: 'text-danger bg-danger/[0.06] border-danger/[0.12]',
},
alertRoot: {},
alertIcon: {},
} satisfies ParsedElementsFragment;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since both the layout and visual styles are needed for each component (I think), have you considered a helper function that'd solve some of the need to have empty objects defined here?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will also have a good amount of these objects for files like the card component which has a good amount of nested components https://github.com/clerk/javascript/blob/main/packages/ui/src/primitives/card.tsx

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The empty objects are a type checking requirement, but after talking with Bryce we decided to move to a runtime validation approach instead. In a future PR, we'll be able to remove these empty objects, and our useAppearance hook will automatically create the empty objects without us needing to specify them.

} from '~/contexts/AppearanceContext';
import * as Icon from './icon';

export const layoutStyle = {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am still not super sold on the layout naming for the based styles. But we can start with it and iterate if we want to change.

Comment threadpackages/ui/src/contexts/AppearanceContext.tsx
Comment on lines -23 to -30
function FirstFactorConnections({
isGlobalLoading,
hasConnection,
}: {
isGlobalLoading: boolean;
hasConnection: boolean;
}) {
const { t } = useLocalizations();

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are these changes meant to be here? 👀

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, I see yes! Alex had a few PRs targeting this branch 👍


export { AppearanceProvider, useAppearance };

if (import.meta.vitest) {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

love that you can test local functions without having to export them!

return result;
}

function mergeAppearance(a: Appearance | null | undefined, b: Appearance | null | undefined): Appearance | null {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might be helpful to outline the merging heuristic in prose in a JSDoc. 👀

@alexcarpenteralexcarpenter left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a solid foundation to build from. I am interested in getting this in sooner than later, and continue iterating on it.

@brkalowbrkalow left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👏 great start!

@dstaley
dstaley merged commit a6a715d into mainSep 4, 2024
@dstaley
dstaley deleted the ds.feat/elements-appearance-prop branch September 4, 2024 19:33
wobsoriano pushed a commit that referenced this pull request Feb 8, 2025
Co-authored-by: Alex Carpenter <im.alexcarpenter@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@dstaley@alexcarpenter@brkalow@github-advanced-security@clerk-cookie
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

feat(ui): Initial AppearanceProvider support - #3976

Merged
dstaley merged 16 commits into
mainfrom
ds.feat/elements-appearance-prop
Sep 4, 2024
Merged

feat(ui): Initial AppearanceProvider support#3976
dstaley merged 16 commits into
mainfrom
ds.feat/elements-appearance-prop

Conversation

@dstaley

@dstaleydstaley commented Aug 16, 2024

Copy link
Copy Markdown
Member

Description

This PR contains a complete implementation of the appearance prop for the new AIO components. Notable changes from the existing appearance prop include the dropping of arbitrary CSS (such as pseudo elements) and the removal of component-specific styles like appearance={{ elements: { signIn: { ... } } }}.

This PR also contains the following sub-PRs:

Checklist

  • npm test runs as expected.
  • npm run build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

@changeset-bot

changeset-botBot commented Aug 16, 2024

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 1ecaaed

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
NameType
@clerk/uiPatch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

<AppearanceProvider appearance={{ layout: { unsafe_disableDevelopmentModeWarnings: devMode === 'off' } }}>
<style
dangerouslySetInnerHTML={{
__html: css,

Check warning

Code scanning / CodeQL

DOM text reinterpreted as HTML

[DOM text](1) is reinterpreted as HTML without escaping meta-characters. [DOM text](2) is reinterpreted as HTML without escaping meta-characters. [DOM text](3) is reinterpreted as HTML without escaping meta-characters.
@dstaley
dstaley marked this pull request as ready for review August 28, 2024 18:31
/**
* Union of all valid descriptors used throughout the components.
*/
export type DescriptorIdentifier = 'alert' | 'alert__error' | 'alert__warning' | 'alertRoot' | 'alertIcon';

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will definitely want to work out an approach for naming here. I think this was just for testing to start. But ideally we have a convention for underscore vs camelcase etc.

Comment on lines +11 to +37
export const layoutStyle = {
alert: {
className: 'border px-4 py-3',
},
alert__warning: {},
alert__error: {},
alertRoot: {
className: 'flex gap-x-2',
},
alertIcon: {
className: 'mt-px shrink-0 *:size-4',
},
} satisfies ParsedElementsFragment;

export const visualStyle = {
alert: {
className: 'leading-small rounded-md text-base',
},
alert__warning: {
className: 'text-warning bg-warning/[0.06] border-warning/[0.12]',
},
alert__error: {
className: 'text-danger bg-danger/[0.06] border-danger/[0.12]',
},
alertRoot: {},
alertIcon: {},
} satisfies ParsedElementsFragment;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since both the layout and visual styles are needed for each component (I think), have you considered a helper function that'd solve some of the need to have empty objects defined here?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will also have a good amount of these objects for files like the card component which has a good amount of nested components https://github.com/clerk/javascript/blob/main/packages/ui/src/primitives/card.tsx

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The empty objects are a type checking requirement, but after talking with Bryce we decided to move to a runtime validation approach instead. In a future PR, we'll be able to remove these empty objects, and our useAppearance hook will automatically create the empty objects without us needing to specify them.

} from '~/contexts/AppearanceContext';
import * as Icon from './icon';

export const layoutStyle = {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am still not super sold on the layout naming for the based styles. But we can start with it and iterate if we want to change.

Comment threadpackages/ui/src/contexts/AppearanceContext.tsx
Comment on lines -23 to -30
function FirstFactorConnections({
isGlobalLoading,
hasConnection,
}: {
isGlobalLoading: boolean;
hasConnection: boolean;
}) {
const { t } = useLocalizations();

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are these changes meant to be here? 👀

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, I see yes! Alex had a few PRs targeting this branch 👍


export { AppearanceProvider, useAppearance };

if (import.meta.vitest) {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

love that you can test local functions without having to export them!

return result;
}

function mergeAppearance(a: Appearance | null | undefined, b: Appearance | null | undefined): Appearance | null {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might be helpful to outline the merging heuristic in prose in a JSDoc. 👀

@alexcarpenteralexcarpenter left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a solid foundation to build from. I am interested in getting this in sooner than later, and continue iterating on it.

@brkalowbrkalow left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👏 great start!

@dstaley
dstaley merged commit a6a715d into mainSep 4, 2024
@dstaley
dstaley deleted the ds.feat/elements-appearance-prop branch September 4, 2024 19:33
wobsoriano pushed a commit that referenced this pull request Feb 8, 2025
Co-authored-by: Alex Carpenter <im.alexcarpenter@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@dstaley@alexcarpenter@brkalow@github-advanced-security@clerk-cookie