Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SDK: Standardize Angular Component CSS Classes and HTML Structure #30957

Open
9 tasks
Tracked by #30943
rjvelazco opened this issue Dec 17, 2024 · 0 comments
Open
9 tasks
Tracked by #30943

SDK: Standardize Angular Component CSS Classes and HTML Structure #30957

rjvelazco opened this issue Dec 17, 2024 · 0 comments

Comments

@rjvelazco
Copy link
Contributor

rjvelazco commented Dec 17, 2024

Caution

THESE ARE BREAKING CHANGES AND SHOULD BE DOCUMENTED

Parent Issue

#30943

Overview

In the Angular SDK, container components render an extra wrapper

when used inside the editor to support inline editing. This div includes inline attributes such as data-dot-*. While necessary for the editor, these extra attributes and inconsistent DOM structures can disrupt user-defined styles.

Task

  1. Update the Angular Container Component to always include the extra wrapper div.
  2. Conditionally apply inline attributes (e.g., data-dot-*) to the wrapper div only when inside the editor.
  3. Ensure the wrapper div uses a consistent class name: dot-container.
  4. Update all CSS classes exposed to users/clients to include the dot- prefix (e.g., dot-container).
  5. Verify the behavior in both editor and live environments.
  6. Update relevant documentation and examples to reflect the changes.

Proposed Objective

Technical User Experience

Proposed Priority

Priority 3 - Average

Acceptance Criteria

Preview Give feedback

External Links... Slack Conversations, Support Tickets, Figma Designs, etc.

No response

Assumptions & Initiation Needs

No response

Quality Assurance Notes & Workarounds

No response

Sub-Tasks & Estimates

  • Refactor the Container Component to ensure attributes are conditionally applied.
  • Standardize the wrapper div's class name to dot-container.
  • Update all exposed CSS classes to use the dot- prefix.
  • Write/update unit tests:
  • Validate attribute presence when inside the editor.
  • Confirm the absence of attributes in production environments.
  • Test the changes in both editor and non-editor environments.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: New
Development

No branches or pull requests

1 participant