Skip to content

Update Changelog (v10.6.0)#1466

Merged
kof merged 2 commits intocssinjs:masterfrom
ITenthusiasm:task/update-changelog
Mar 14, 2021
Merged

Update Changelog (v10.6.0)#1466
kof merged 2 commits intocssinjs:masterfrom
ITenthusiasm:task/update-changelog

Conversation

@ITenthusiasm
Copy link
Copy Markdown
Member

This is a PR to specify the changes from #1460 in the changelog. These details are related to #1460 only. With guidance, if desired, I would gladly add any additional details that seem relevant to v10.6.0.

@ITenthusiasm ITenthusiasm requested a review from kof as a code owner March 11, 2021 22:28
@ITenthusiasm
Copy link
Copy Markdown
Member Author

cc @kof

After this is resolved, I'll probably start looking at a way to add helpful TS info to the docs. #1459 can probably come after that.

@ITenthusiasm ITenthusiasm force-pushed the task/update-changelog branch from cd7a7be to 2103982 Compare March 11, 2021 22:34
@ITenthusiasm
Copy link
Copy Markdown
Member Author

ITenthusiasm commented Mar 11, 2021

Amended commit to make the use of semicolons consistent in the examples.

Comment thread changelog.md Outdated
---

### Bug fixes
## 10.6.0 (2021-03-11)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

version is generated upon release

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Gotcha. I'll remove it then.

Comment thread changelog.md Outdated
- [react-jss] `Theme` is no longer the first generic type parameter for `createUseStyles`. [1460](https://github.com/cssinjs/jss/pull/1460)
- There are two main ways to tell TypeScript your `Theme`'s type without reaching over the other type parameters:

Using the function argument. (Recommended)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I wouldn't encourage using this interface until we decide what to do with it, we had a discussion to remove it for various reasons

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Ah, I wasn't aware. I'll remove the "Recommended" piece then. Should the functional example be removed as well or should it stay?

Comment thread changelog.md Outdated

```typescript
const useStyles = createUseStyles({
className: ({theme}: {theme: Theme}) => ({
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

className is misleading, because it would mean it's actual classname, where actual class name is generated, this is what we call a rule name

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

That's fair. I'll rename it to ruleName then.

Comment thread changelog.md Outdated
- [jss-preset-default](https://github.com/cssinjs/jss-preset-default/blob/master/changelog.md)
- [react-jss](./docs/react-jss.md/blob/master/changelog.md)

```
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Yeah that one's confusing to me. 🤔 It definitely wasn't intentional. Glad you noticed it though.

@ITenthusiasm
Copy link
Copy Markdown
Member Author

Pushed some additional changes based on the feedback. I'll squash the commits and clean up the history when everything is finalized.

@ITenthusiasm
Copy link
Copy Markdown
Member Author

If there are any other improvements that need to be made, feel free to let me know.

@kof kof merged commit a4c20c5 into cssinjs:master Mar 14, 2021
@kof
Copy link
Copy Markdown
Member

kof commented Mar 14, 2021

merged, thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants