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

feat(material/schematics): add option not to include animations module in ng-add #22559

Merged
merged 1 commit into from
Feb 26, 2022

Conversation

crisbeto
Copy link
Member

Adds a third option to the ng-add schematic that allows users to opt out of including any of the animations modules.

@crisbeto crisbeto added P3 An issue that is relevant to core functions, but does not impede progress. Important, but not urgent merge safe target: minor This PR is targeted for the next minor release labels Apr 24, 2021
@crisbeto crisbeto requested review from jelbourn and devversion April 24, 2021 11:50
@google-cla google-cla bot added the cla: yes PR author has agreed to Google's Contributor License Agreement label Apr 24, 2021
Copy link
Member

@devversion devversion left a comment

Choose a reason for hiding this comment

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

LGTM

"x-prompt": "Set up browser animations for Angular Material?"
"type": "string",
"default": "enabled",
"description": "Whether Angular browser animations should be included.",
Copy link
Member

Choose a reason for hiding this comment

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

Could we elaborate here on which components strictly require an animations module to function?

Copy link
Member Author

Choose a reason for hiding this comment

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

We could, but then the option will be somewhat long and the list is bound to go out of date.

Copy link
Member

Choose a reason for hiding this comment

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

I don't think the option is really useful without communicating that somehow, though. I wouldn't expect someone to go looking through the source to figure out where it's necessary, and letting someone omit animations just to then get an error when they try to use a component isn't a great experience.

Copy link
Member Author

Choose a reason for hiding this comment

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

I feel like that would be too much text to fit in a multi-select list in the command line. We could generate a list of components using animations from the source code and publish it as a URL on material.angular.io that we then link to from the schematic. It might take a while to do it though.

Copy link
Member

Choose a reason for hiding this comment

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

Something like that would probably be useful. I've been meaning to write an "About" page for material.angular.io for a while and a good section there would be "Animations supports"

@andrewseguin andrewseguin removed the cla: yes PR author has agreed to Google's Contributor License Agreement label Dec 28, 2021
@googlebot googlebot added the cla: yes PR author has agreed to Google's Contributor License Agreement label Dec 29, 2021
…e in ng-add

Adds a third option to the `ng-add` schematic that allows users to opt out of including any of the animations modules.
@crisbeto crisbeto force-pushed the ng-add-animations-exclude branch from c3bca6c to 52ceaba Compare February 26, 2022 16:42
@crisbeto crisbeto added action: merge The PR is ready for merge by the caretaker and removed needs rebase labels Feb 26, 2022
@crisbeto crisbeto merged commit 38334d6 into angular:master Feb 26, 2022
@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 Mar 29, 2022
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 cla: yes PR author has agreed to Google's Contributor License Agreement P3 An issue that is relevant to core functions, but does not impede progress. Important, but not urgent target: minor This PR is targeted for the next minor release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants