Skip to content

docs(cdk/dialog): add initial setup instructions for CDK dialogs #29209

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

Merged
merged 2 commits into from
Jun 8, 2024

Conversation

ifrntnd
Copy link
Contributor

@ifrntnd ifrntnd commented Jun 6, 2024

Added instructions for including structural styles required by CDK dialogs. Noted that without importing @angular/cdk/overlay-prebuilt.css in the global stylesheet, CDK dialogs did not work correctly.

Added instructions for including structural styles required by CDK dialogs. Noted that without importing '@angular/cdk/overlay-prebuilt.css' in the global stylesheet, CDK dialogs did not work correctly.
@ifrntnd ifrntnd requested a review from a team as a code owner June 6, 2024 20:00
@ifrntnd ifrntnd requested review from amysorto and wagnermaciel and removed request for a team June 6, 2024 20:00
@angular-robot angular-robot bot added the area: docs Related to the documentation label Jun 6, 2024
The CDK dialogs depend on a small set of structural styles to work correctly. If you're using
Angular Material, these styles have been included together with the theme, otherwise if you're
using the CDK on its own, you'll have to include the styles yourself. You can do so by importing
the prebuilt styles in your global stylesheet:
Copy link
Member

Choose a reason for hiding this comment

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

Might be worth mentioning that one can also get these styles by including the cdk.overlay mixin.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@crisbeto I've updated the instructions to include an alternative method using the cdk.overlay mixin in Sass.

Added alternative method for including CDK styles using the cdk.overlay mixin
@crisbeto crisbeto self-assigned this Jun 7, 2024
@crisbeto crisbeto added action: merge The PR is ready for merge by the caretaker target: patch This PR is targeted for the next patch release labels Jun 7, 2024
@crisbeto
Copy link
Member

crisbeto commented Jun 7, 2024

@ifrntnd I can't merge in the change because of the third merge commit. Can you drop it from the PR?

@ifrntnd ifrntnd force-pushed the docs/update-cdk-dialog-setup branch from 3c1a194 to 5a0a595 Compare June 7, 2024 14:43
@angular-robot angular-robot bot requested a review from crisbeto June 7, 2024 14:43
@ifrntnd
Copy link
Contributor Author

ifrntnd commented Jun 7, 2024

@ifrntnd I can't merge in the change because of the third merge commit. Can you drop it from the PR?

@crisbeto Done. I dropped the third merge commit from the PR

@crisbeto crisbeto merged commit 35f07c5 into angular:main Jun 8, 2024
21 of 22 checks passed
crisbeto pushed a commit that referenced this pull request Jun 8, 2024
)

* docs(cdk/dialog): add initial setup instructions for CDK dialogs

Added instructions for including structural styles required by CDK dialogs. Noted that without importing '@angular/cdk/overlay-prebuilt.css' in the global stylesheet, CDK dialogs did not work correctly.

* docs(cdk/dialog): added cdk.overlay mixin import

Added alternative method for including CDK styles using the cdk.overlay mixin

(cherry picked from commit 35f07c5)
@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Jul 9, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
action: merge The PR is ready for merge by the caretaker area: docs Related to the documentation target: patch This PR is targeted for the next patch release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants