iconName => icon prop #2070
iconName => icon prop #2070
Conversation
giladgray
changed the title
fix testsPreview: documentation | landing | table |
fix icons docsPreview: documentation | landing | table |
bring back LegacyIconName (one big break per PR)Preview: documentation | landing | table |
|
can you update the prop renaming script to include |
semantic merge conflictsPreview: documentation | landing | table |
add iconName to rename scriptPreview: documentation | landing | table |
giladgray
force-pushed
the
gg/icon-prop
branch
from
582182e
to
f3c805a
Compare
add iconName to rename scriptPreview: documentation | landing | table |
| */ | ||
| iconName?: LegacyIconName; | ||
| icon: LegacyIconName | JSX.Element | false | null | undefined; |
There was a problem hiding this comment.
this is pretty unintuitive, so you should leave clearer documentation on why would a user want to use this with JSX.Element since it's just a pass-through render. the short answer is: they wouldn't. it's only there to make our codebase cleaner since <Icon> is used everywhere.
| import { IconClasses } from "@blueprintjs/core"; | ||
| <Icon iconName={IconClasses.ALIGN_LEFT} iconSize={Icon.SIZE_LARGE} /> | ||
| <Icon iconName="globe" iconSize={20} /> | ||
| <Icon iconName="graph" iconSize={Icon.SIZE_LARGE} intent={Intent.PRIMARY} /> |
There was a problem hiding this comment.
need to update these usage docs
|
|
||
| it("iconName=undefined renders nothing", () => { | ||
| const icon = shallow(<Icon iconName={undefined} />); | ||
| it("passes through icon element unchanged", () => { |
There was a problem hiding this comment.
also leave that documentation here, to explain why we're supporting this weird prop
giladgray
changed the title
| @@ -57,3 +59,12 @@ export class MenuExample extends BaseExample<{}> { | |||
| ); | |||
| } | |||
| } | |||
|
|
|||
| const PalantirLogo: React.SFC = () => ( | |||
| <svg className={Classes.ICON} width="16" height="16" viewBox="0 0 18 23" xmlns="http://www.w3.org/2000/svg"> | |||
There was a problem hiding this comment.
@adidahiya maybe some props should be passed into given icon element?
especially if it's an svg element: className, iconSize, color.
or we could support a paths prop?
There was a problem hiding this comment.
no, I'd rather not add that complexity to <Icon>
add custom svg icon itemPreview: documentation | landing | table |
Merge branch 'develop' of github.com:palantir/blueprint into gg/icon-propPreview: documentation | landing | table |
| @@ -57,3 +59,12 @@ export class MenuExample extends BaseExample<{}> { | |||
| ); | |||
| } | |||
| } | |||
|
|
|||
| const PalantirLogo: React.SFC = () => ( | |||
| <svg className={Classes.ICON} width="16" height="16" viewBox="0 0 18 23" xmlns="http://www.w3.org/2000/svg"> | |||
There was a problem hiding this comment.
no, I'd rather not add that complexity to <Icon>
|
icons page fixed |
bold icon namesPreview: documentation | landing | table |
Fixes #2066
Checklist
Changes proposed in this pull request:
IconiconName?: IconName=>icon?: LegacyIconName | JSX.Element | false | null | undefinedicon?: IconName | JSX.ElementleftIconName,rightIconNameget the same treatment