Skip to content

docs(material/checkbox): updated docs for default option value for ch… #21226

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

Closed
wants to merge 10 commits into from
Closed

Conversation

adhispace
Copy link
Contributor

…eckbox

updates the documentation of customizing the default option of the checkbox.
the default option value to provide for checkbox is MAT_CHECKBOX_DEFAULT_OPTIONS for version>=10

fixes #21025

…eckbox

updates the documentation of customizing the default option of the checkbox.
the default option value to provide for checkbox is MAT_CHECKBOX_DEFAULT_OPTIONS for version>=10

fixes #21025
…eckbox

updates the documentation of customizing the default option of the checkbox.
the default option value to provide for checkbox is MAT_CHECKBOX_DEFAULT_OPTIONS for version>=10

fixes #21025
@google-cla google-cla bot added the cla: yes PR author has agreed to Google's Contributor License Agreement label Dec 6, 2020
Copy link
Member

@crisbeto crisbeto left a comment

Choose a reason for hiding this comment

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

Thank you for the PR. The changes look good, but we still have a couple other places where MAT_CHECKBOX_CLICK_ACTION is referenced in the docs. Can we take the chance to update them as well?

Here's where it needs to be updated:

src\material\checkbox\testing\checkbox-harness.ts
src\material-experimental\mdc-checkbox\testing\checkbox-harness.ts

@adhispace
Copy link
Contributor Author

Thank you for the PR. The changes look good, but we still have a couple other places where MAT_CHECKBOX_CLICK_ACTION is referenced in the docs. Can we take the chance to update them as well?

Here's where it needs to be updated:

src\material\checkbox\testing\checkbox-harness.ts
src\material-experimental\mdc-checkbox\testing\checkbox-harness.ts

yes. sure...will make changes...

@adhispace
Copy link
Contributor Author

I find MAT_CHECKBOX_CLICK_ACTION is also being referenced in

  1. few test case definitions also like
    describe(when MAT_CHECKBOX_CLICK_ACTION is 'check', () => {}
    found in
    src/material-experimental/mdc-checkbox/checkbox.spec.ts
    src/material/checkbox.spec.ts
  2. src/material/schematics/ng-update/migrations/package-imports-v8/material-symbols.json
    line 58 - "MAT_CHECKBOX_CLICK_ACTION": "checkbox"

shall I make changes there as well ?
thanks

@crisbeto
Copy link
Member

crisbeto commented Dec 6, 2020

Let's leave those in since they're unit tests. We can clean them up once the deprecated symbol is removed completely.

@adhispace
Copy link
Contributor Author

adhispace commented Dec 6, 2020

Let's leave those in since they're unit tests. We can clean them up once the deprecated symbol is removed completely.

ok fine...will leave those..

…PTIONS for customizing checkbox behaviour

updates the comments in testing files in checkbox with MAT_CHECKBOX_DEFAULT_OPTIONS
the default option value to provide for checkbox is MAT_CHECKBOX_DEFAULT_OPTIONS for version>=10

fixes #21025
@adhispace adhispace requested a review from mmalerba as a code owner December 6, 2020 12:18
…eckbox

updates the comments in testing files in checkbox with MAT_CHECKBOX_DEFAULT_OPTIONS
the default option value to provide for checkbox is MAT_CHECKBOX_DEFAULT_OPTIONS for version>=10

fixes #21025
…eckbox

updates the comments in testing files in checkbox with MAT_CHECKBOX_DEFAULT_OPTIONS
the default option value to provide for checkbox is MAT_CHECKBOX_DEFAULT_OPTIONS for version>=10

fixes #21025
…PTIONS for customizing checkbox behaviour

updates the comments in testing files in checkbox with MAT_CHECKBOX_DEFAULT_OPTIONS
the default option value to provide for checkbox is MAT_CHECKBOX_DEFAULT_OPTIONS for version>=10

fixes #21025
…PTIONS for customizing checkbox behaviour

updates the comments in testing files in checkbox with MAT_CHECKBOX_DEFAULT_OPTIONS
the default option value to provide for checkbox is MAT_CHECKBOX_DEFAULT_OPTIONS for version>=10

fixes #21025
…PTIONS for customizing checkbox behaviour

updates the comments in testing files in checkbox with MAT_CHECKBOX_DEFAULT_OPTIONS
the default option value to provide for checkbox is MAT_CHECKBOX_DEFAULT_OPTIONS for version>=10

fixes #21025
… value for checkbox

updates the documentation of customizing the default option of the checkbox.
the default option value to provide for checkbox is MAT_CHECKBOX_DEFAULT_OPTIONS for version>=10

fixes #21025
@adhispace adhispace requested a review from crisbeto December 6, 2020 13:29
…PTIONS for customizing checkbox behaviour

updates the comments in testing files in checkbox with MAT_CHECKBOX_DEFAULT_OPTIONS
the default option value to provide for checkbox is MAT_CHECKBOX_DEFAULT_OPTIONS for version>=10

fixes #21025
@adhispace
Copy link
Contributor Author

adhispace commented Dec 6, 2020

Hi...I made the suggested changes. but im not sure why the circleci build fails. Im trying to solve this, but finding it bit difficult. this is my first PR. if you have time can you please help me solve this. else I shall open a new PR with these changes.
(I made few redundant commits to test if I made any mistake in the commit message. I will avoid in future)
thanks

@adhispace
Copy link
Contributor Author

I will close this pull request and open a new one :)

@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 Jan 6, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
cla: yes PR author has agreed to Google's Contributor License Agreement
Projects
None yet
2 participants