UNSAFE classname test #1826
Draft
UNSAFE classname test #1826
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
the
refactoring
✅ Deploy Preview for spirit-design-system ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for spirit-design-system-storybook ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
literat
reviewed
Jan 10, 2025
| @@ -52,4 +52,6 @@ const _Button = <T extends ElementType = 'button', C = void, S = void>( | |||
|
|
|||
| const Button = forwardRef<HTMLButtonElement, SpiritButtonProps<ElementType>>(_Button); | |||
|
|
|||
| Button.isSystemComponent = true; | |||
There was a problem hiding this comment.
suggestion: I think, we will use something like Button.spiritComponent = Button for cases where we want to check if it is a Spirit component or if we want a name.
There was a problem hiding this comment.
Or we can use Button.isSpiritComponent first and reimplement it when needed.
literat
reviewed
Jan 10, 2025
| const styleProps = { | ||
| style: Object.keys(style).length > 0 ? style : undefined, | ||
| className: classNames(UNSAFE_className, ...styleUtilities) || undefined, | ||
| const rimmerProps = { |
There was a problem hiding this comment.
suggestion: Please, remove this.
literat
reviewed
Jan 10, 2025
| ...(UNSAFE_style !== undefined && { UNSAFE_style }), | ||
| ...(UNSAFE_className !== undefined && { UNSAFE_className }), | ||
| }, | ||
| props: rimmerProps as HTMLAttributes<HTMLElement>, |
There was a problem hiding this comment.
suggestion: This should be refactored back.
literat
reviewed
Jan 10, 2025
| // For backward compatibility! | ||
| /** Sets the CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the element. Only use as a **last resort**. Use style props instead. */ | ||
| UNSAFE_className?: string; | ||
| /** Sets inline [style](https://developer.mozilla.org/en-US/docs/Web/API/Element/style) for the element. Only use as a **last resort**. Use style props instead. */ | ||
| UNSAFE_style?: CSSProperties; | ||
| useUnsafe?: boolean; |
There was a problem hiding this comment.
suggestion: We do not need this anymore.
literat
reviewed
Jan 10, 2025
| props: HTMLAttributes<HTMLElement>; | ||
| }; | ||
|
|
||
| export function useStyleProps<T extends StyleProps>(props: T): StylePropsResult { | ||
| const classNamePrefix = useContext(ClassNamePrefixContext); | ||
| const { UNSAFE_className, UNSAFE_style, ...otherProps } = props; | ||
| const { UNSAFE_className, UNSAFE_style, ElementTag, ...otherProps } = props; |
There was a problem hiding this comment.
suggestion: I think we should pass here only the bool value and not the entire ElementTag/Component.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
UNSAFE_className,UNSAFE_styleclassName,style, etc.Warning
Some components are still broken and will need to be fixed in upcoming changes.
The problem is that some components spread their props, while others combine classes inline.
Additional context
Note
Testing demo available at Next.js app router: http://localhost:3000/test1
Issue reference
(UNSAFE_)className v elementType komponentach