Skip to content
This repository was archived by the owner on Sep 5, 2024. It is now read-only.

docs(changelog): add md-selected-text not accepting HTML anymore as a breaking change in 1.1.5 #10912

Closed
aghArdeshir opened this issue Sep 20, 2017 · 7 comments · Fixed by #11442
Assignees
Labels
has: Pull Request A PR has been created to address this issue P1: urgent Urgent issues that should be addressed in the next minor or patch release. resolution: fixed type: docs
Milestone

Comments

@aghArdeshir
Copy link
Contributor

HI! Recently we wanted to migrate from angularjs material 1.1.1 to 1.1.4 (but finally did 1.1.5 as described below), we used the CHANGELOG.md as our migration tour guide : )
But it wasn't helpful in some situations:

  • Our website is multi-directional, the first thing we encountered was in 1.1.4, all tooltips in RTL were attached to the right-most of the page instead of element. I'm not sure which version broke it, but I think there should be a breaking change log about this in your changelog file. That's why we decided to move to 1.1.5 instead of 1.1.4 (which later we found was a good thing : ))

  • the main reason we decided to update our angularjs material was that multiple option of dialog which is added from 1.1.4 to documentation : https://material.angularjs.org/1.1.4/api/service/$mdDialog
    But nowhere in changelog it was mentioned (btw, its great, thanks : ))

  • There is a big breaking change which annoyed us a lot and took some time to debug and find where the problem is, all our md-colors were broke. like this: md-colors="{background:'green-500'}" resulted in an error like this : '-green' couldn't be find in color pallete (or something like that). That - (dash) was added at the beginning of every color we used and broke them all. That was caused in 1.1.2. by this I think :7090a1f
    The solution was just to add a md-theme="default" to our <body> tag and to each of our dialogs one by one (even if dialogs were opened inside body), that just solved the problem, I assume it as a bug, because it took away default usage of md-colors, but if its not a bug, please add it to breaking changes of 1.1.2
    something we found that might be helpful about this one were these few lines:

      `compile: function (tElem, tAttrs) {
      var shouldWatch = shouldColorsWatch(); return function (scope, element, attrs, ctrl) {`
        `var mdThemeController = ctrl[0];`
    
        `var lastColors = {};`
    

do you see that ctrl[0] ? it was null in 1.1.1, but it existed as an object from 1.1.2

  • also a minor thing : in your 1.1.5, there is a long text explaining something about $mdCompile, that breaks the nice flow of your beautiful bullet list changelog, and also its scary, first I thought maybe everything is changed in 1.1.5 : ). I think it would be nicer if a link is provided to somewhere else which explains it.

Thanks ! :)
Keep up the good work 👍

@aghArdeshir
Copy link
Contributor Author

  • One thing I found recently :
    mdSelectedText used to accept HTML in 1.1.1 but in 1.1.5 it does not accept HTML .
    all of our usages of md-selected-text are rendered as <span dir="auto">something</span> instead of something.

That is a breaking change.

the change is mentioned in documentation
https://material.angularjs.org/1.1.5/api/directive/mdSelect
https://material.angularjs.org/1.1.1/api/directive/mdSelect

Thanks ! :)

@Splaktar Splaktar self-assigned this Jan 21, 2018
@Splaktar Splaktar added needs: demo A CodePen demo or GitHub repository is needed to demonstrate the reproduction of the issue needs: investigation The cause of this issue is not well understood and needs to be investigated by the team or community labels Jan 21, 2018
@Splaktar
Copy link
Contributor

I will try to take a look at this soon. For future reference, it would be helpful to open the separate issues that you ran into as separate GitHub issues. This can avoid critical issues being lost in a list of other issues.

@aghArdeshir
Copy link
Contributor Author

Yes! Of Course!
Sorry and thanks : )

@Splaktar Splaktar added this to the 1.1.8 milestone Feb 26, 2018
@Splaktar
Copy link
Contributor

  • Tooltips and RTL, please test with 1.1.7 and if there is a bug still, please open a new issue with a CodePen repro.
  • for multiple that is because it was first introduced in 1.1.2 where it has a change log entry (mentioning interims instead of dialogs specifically).
  • I swear that I saw another open issue that mentioned the dash issue with md-colors, but I can't find it. Can you please try a search through the issues and if you can't find one open for that, can you please open a new issue with a CodePen repro?
  • md-selected-text only accepting text and not HTML does seem like a breaking change. I'll update this issue's title to just focus on that one issue of the changelog.

@Splaktar Splaktar added type: docs and removed needs: investigation The cause of this issue is not well understood and needs to be investigated by the team or community labels Mar 16, 2018
@Splaktar Splaktar changed the title some issues in changelog docs(changelog): add md-selected-text not accepting HTML anymore as a breaking change in 1.1.5 Mar 16, 2018
@Splaktar Splaktar added P1: urgent Urgent issues that should be addressed in the next minor or patch release. for: external contributor and removed needs: demo A CodePen demo or GitHub repository is needed to demonstrate the reproduction of the issue good first issue labels Mar 16, 2018
@Splaktar
Copy link
Contributor

Tagged this as a good issue for an external contributor, but removed the good first issue tag since the OP might confuse a first time contributor as it doesn't follow the issue template and includes multiple issues in a single report.

@Splaktar
Copy link
Contributor

Splaktar commented Mar 16, 2018

For colors, I found the issue and the PR (#11078) which was just merged and will be in 1.1.8.

@Splaktar Splaktar modified the milestones: 1.1.8, 1.1.9 Mar 17, 2018
@Splaktar Splaktar modified the milestones: 1.1.9, 1.1.10 Apr 19, 2018
@Splaktar Splaktar modified the milestones: 1.1.10, 1.1.11 Jun 19, 2018
@Splaktar
Copy link
Contributor

The breaking change for md-selected-text was a XSS security fix (#10023) in 1.1.2. I'm working on a changelog update atm.

For $mdDialog and multiple, the docs were added in 1.1.2 via PR #9950. The functionality was added in PR #9053. Also as mentioned above, it has a changlog entry:

@Splaktar Splaktar added has: Pull Request A PR has been created to address this issue and removed needs: Pull Request labels Sep 11, 2018
mmalerba pushed a commit that referenced this issue Sep 19, 2018
…11442)

<!-- 
Filling out this template is required! Do not delete it when submitting a Pull Request! Without this information, your Pull Request may be auto-closed.
-->
## PR Checklist
Please check that your PR fulfills the following requirements:
- [x] The commit message follows [our guidelines](https://github.com/angular/material/blob/master/.github/CONTRIBUTING.md#-commit-message-format)
- [x] Tests for the changes have been added or this is not a bug fix / enhancement
- [x] Docs have been added, updated, or were not required

## PR Type
What kind of change does this PR introduce?
<!-- Please check the one that applies to this PR using "x". -->
```
[ ] Bugfix
[ ] Enhancement
[x] Documentation content changes
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[ ] Infrastructure changes
[ ] Other... Please describe:
```

## What is the current behavior?
#10912 (comment)
<!-- Please describe the current behavior that you are modifying and link to one or more relevant issues. -->
Issue Number: 
Fixes #10912.

## What is the new behavior?
We document this API change as a breaking change in 1.1.2 and provide guidance on code migration.

## Does this PR introduce a breaking change?
```
[ ] Yes
[x] No
```
<!-- If this PR contains a breaking change, please describe the impact and migration path for existing applications below. -->
<!-- Note that breaking changes are highly unlikely to get merged to master unless the validation is clear and the use case is critical. -->

## Other information
nobitagit pushed a commit to nobitagit/material that referenced this issue Sep 24, 2018
…ngular#11442)

<!-- 
Filling out this template is required! Do not delete it when submitting a Pull Request! Without this information, your Pull Request may be auto-closed.
-->
## PR Checklist
Please check that your PR fulfills the following requirements:
- [x] The commit message follows [our guidelines](https://github.com/angular/material/blob/master/.github/CONTRIBUTING.md#-commit-message-format)
- [x] Tests for the changes have been added or this is not a bug fix / enhancement
- [x] Docs have been added, updated, or were not required

## PR Type
What kind of change does this PR introduce?
<!-- Please check the one that applies to this PR using "x". -->
```
[ ] Bugfix
[ ] Enhancement
[x] Documentation content changes
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[ ] Infrastructure changes
[ ] Other... Please describe:
```

## What is the current behavior?
angular#10912 (comment)
<!-- Please describe the current behavior that you are modifying and link to one or more relevant issues. -->
Issue Number: 
Fixes angular#10912.

## What is the new behavior?
We document this API change as a breaking change in 1.1.2 and provide guidance on code migration.

## Does this PR introduce a breaking change?
```
[ ] Yes
[x] No
```
<!-- If this PR contains a breaking change, please describe the impact and migration path for existing applications below. -->
<!-- Note that breaking changes are highly unlikely to get merged to master unless the validation is clear and the use case is critical. -->

## Other information
marosoft pushed a commit to marosoft/material that referenced this issue Nov 11, 2018
…ngular#11442)

<!-- 
Filling out this template is required! Do not delete it when submitting a Pull Request! Without this information, your Pull Request may be auto-closed.
-->
## PR Checklist
Please check that your PR fulfills the following requirements:
- [x] The commit message follows [our guidelines](https://github.com/angular/material/blob/master/.github/CONTRIBUTING.md#-commit-message-format)
- [x] Tests for the changes have been added or this is not a bug fix / enhancement
- [x] Docs have been added, updated, or were not required

## PR Type
What kind of change does this PR introduce?
<!-- Please check the one that applies to this PR using "x". -->
```
[ ] Bugfix
[ ] Enhancement
[x] Documentation content changes
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[ ] Infrastructure changes
[ ] Other... Please describe:
```

## What is the current behavior?
angular#10912 (comment)
<!-- Please describe the current behavior that you are modifying and link to one or more relevant issues. -->
Issue Number: 
Fixes angular#10912.

## What is the new behavior?
We document this API change as a breaking change in 1.1.2 and provide guidance on code migration.

## Does this PR introduce a breaking change?
```
[ ] Yes
[x] No
```
<!-- If this PR contains a breaking change, please describe the impact and migration path for existing applications below. -->
<!-- Note that breaking changes are highly unlikely to get merged to master unless the validation is clear and the use case is critical. -->

## Other information
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
has: Pull Request A PR has been created to address this issue P1: urgent Urgent issues that should be addressed in the next minor or patch release. resolution: fixed type: docs
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants