-
Notifications
You must be signed in to change notification settings - Fork 2.2k
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
[Labs] new TagInput component! #1232
Merged
Merged
Changes from 3 commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
1435bb6
initial TagInput implementation
48f7c71
docs + polish
c9d67b4
tests! sufficient coverage :+1:
7bebcd9
move code to subdirectory, use "fake" names
0de6fef
add Tag active prop and .pt-active style support
c6545df
left/right arrows to navigate through tags list and remove _any_ (not…
5166bc1
fix lint
41a9e1f
refactor keyboard logic and introduce NONE constant
e5ccb76
set explicit width to break long words
f219fda
notes, remove commented code
7275e31
🌳 remove logs
6e74699
Merge branch 'master' of github.com:palantir/blueprint into gg/taginput
960f305
rename dir to tag-input
d441a73
add docs about keyboard interactions
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -14,12 +14,12 @@ import { isFunction } from "../../common/utils"; | |
|
||
import * as Classes from "../../common/classes"; | ||
|
||
export interface ITagProps extends IProps, IIntentProps, React.HTMLProps<HTMLSpanElement> { | ||
export interface ITagProps extends IProps, IIntentProps, React.HTMLAttributes<Tag> { | ||
/** | ||
* Click handler for remove button. | ||
* Button will only be rendered if this prop is defined. | ||
*/ | ||
onRemove?: (e: React.MouseEvent<HTMLSpanElement>) => void; | ||
onRemove?: (e: React.MouseEvent<HTMLButtonElement>) => void; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. previous type was incorrect, as the |
||
} | ||
|
||
@PureRender | ||
|
@@ -31,8 +31,9 @@ export class Tag extends React.Component<ITagProps, {}> { | |
const tagClasses = classNames(Classes.TAG, Classes.intentClass(intent), { | ||
[Classes.TAG_REMOVABLE]: onRemove != null, | ||
}, className); | ||
const button = | ||
isFunction(onRemove) ? <button type="button" className={Classes.TAG_REMOVE} onClick={onRemove} /> : undefined; | ||
const button = isFunction(onRemove) | ||
? <button type="button" className={Classes.TAG_REMOVE} onClick={onRemove} /> | ||
: undefined; | ||
|
||
return ( | ||
<span {...removeNonHTMLProps(this.props)} className={tagClasses}> | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,3 +6,4 @@ | |
*/ | ||
|
||
export * from "./selectExample"; | ||
export * from "./tagInputExample"; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,90 @@ | ||
/* | ||
* Copyright 2017 Palantir Technologies, Inc. All rights reserved. | ||
* Licensed under the BSD-3 License as modified (the “License”); you may obtain a copy | ||
* of the license at https://github.com/palantir/blueprint/blob/master/LICENSE | ||
* and https://github.com/palantir/blueprint/blob/master/PATENTS | ||
*/ | ||
|
||
import * as React from "react"; | ||
|
||
import { Classes, Intent, ITagProps, Switch } from "@blueprintjs/core"; | ||
import { BaseExample, handleBooleanChange } from "@blueprintjs/docs"; | ||
import { TagInput } from "../src/tagInput"; | ||
|
||
const INTENTS = [Intent.NONE, Intent.PRIMARY, Intent.SUCCESS, Intent.DANGER, Intent.WARNING]; | ||
|
||
export interface ITagInputExampleState { | ||
intent?: boolean; | ||
large?: boolean; | ||
minimal?: boolean; | ||
values?: string[]; | ||
} | ||
|
||
export class TagInputExample extends BaseExample<ITagInputExampleState> { | ||
public state: ITagInputExampleState = { | ||
intent: false, | ||
large: false, | ||
minimal: false, | ||
values: ["Gilad", "Antoine", "Chris"], | ||
}; | ||
|
||
private handleIntentChange = handleBooleanChange((intent) => this.setState({ intent })); | ||
private handleLargeChange = handleBooleanChange((large) => this.setState({ large })); | ||
private handleMinimalChange = handleBooleanChange((minimal) => this.setState({ minimal })); | ||
|
||
protected renderExample() { | ||
const { large, values } = this.state; | ||
|
||
// define a new function every time so switch changes will cause it to re-render | ||
// NOTE: avoid this pattern in your app (use this.getTagProps instead); this is only for | ||
// example purposes!! | ||
const getTagProps = (_v: string, index: number): ITagProps => ({ | ||
className: this.state.minimal ? Classes.MINIMAL : "", | ||
intent: this.state.intent ? INTENTS[index % INTENTS.length] : Intent.NONE, | ||
}); | ||
|
||
return ( | ||
<TagInput | ||
className={large ? Classes.LARGE : ""} | ||
onAdd={this.handleAdd} | ||
onRemove={this.handleRemove} | ||
tagProps={getTagProps} | ||
values={values} | ||
/> | ||
); | ||
} | ||
|
||
protected renderOptions() { | ||
return [ | ||
[ | ||
<Switch | ||
checked={this.state.large} | ||
label="Large" | ||
key="large" | ||
onChange={this.handleLargeChange} | ||
/>, | ||
], [ | ||
<label key="heading" className={Classes.LABEL}>Tag props</label>, | ||
<Switch | ||
checked={this.state.minimal} | ||
label="Use minimal tags" | ||
key="minimal" | ||
onChange={this.handleMinimalChange} | ||
/>, | ||
<Switch | ||
checked={this.state.intent} | ||
label="Cycle through intents" | ||
key="intent" | ||
onChange={this.handleIntentChange} | ||
/>, | ||
], | ||
]; | ||
} | ||
|
||
private handleAdd = (newValue: string) => { | ||
this.setState({ values: [...this.state.values, newValue] }); | ||
} | ||
private handleRemove = (_removedValue: string, removedIndex: number) => { | ||
this.setState({ values: this.state.values.filter((_, i) => i !== removedIndex) }); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -7,3 +7,4 @@ | |
|
||
export * from "./inputList"; | ||
export * from "./select"; | ||
export * from "./tagInput"; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,137 @@ | ||
/* | ||
* Copyright 2017 Palantir Technologies, Inc. All rights reserved. | ||
* Licensed under the BSD-3 License as modified (the “License”); you may obtain a copy | ||
* of the license at https://github.com/palantir/blueprint/blob/master/LICENSE | ||
* and https://github.com/palantir/blueprint/blob/master/PATENTS | ||
*/ | ||
|
||
import * as classNames from "classnames"; | ||
import * as PureRender from "pure-render-decorator"; | ||
import * as React from "react"; | ||
|
||
import { AbstractComponent, Classes, HTMLInputProps, IProps, ITagProps, Keys, Tag, Utils } from "@blueprintjs/core"; | ||
|
||
export interface ITagInputProps extends IProps { | ||
/** React props to pass to the `<input>` element */ | ||
inputProps?: HTMLInputProps; | ||
|
||
/** | ||
* Callback invoked when a new tag is added by the user pressing `enter` on the input. | ||
* Receives the current value of the input field. New tags are expected to be appended to | ||
* the list. | ||
*/ | ||
onAdd?: (value: string) => void; | ||
|
||
/** | ||
* Callback invoked when the user clicks the X button on a tag. | ||
* Receives value and index of removed tag. | ||
*/ | ||
onRemove?: (value: string, index: number) => void; | ||
|
||
/** | ||
* React props to pass to each `Tag`. Provide an object to pass the same props to every tag, | ||
* or a function to customize props per tag. | ||
* | ||
* If you define `onRemove` here then you will have to implement your own tag removal | ||
* handling as the `TagInput` `onRemove` prop will never be invoked. | ||
*/ | ||
tagProps?: ITagProps | ((value: string, index: number) => ITagProps); | ||
|
||
/** Controlled tag values. */ | ||
values: string[]; | ||
} | ||
|
||
export interface ITagInputState { | ||
inputValue?: string; | ||
isInputFocused?: boolean; | ||
} | ||
|
||
@PureRender | ||
export class TagInput extends AbstractComponent<ITagInputProps, ITagInputState> { | ||
public static displayName = "Blueprint.TagInput"; | ||
|
||
public static defaultProps: Partial<ITagInputProps> = { | ||
inputProps: {}, | ||
tagProps: {}, | ||
}; | ||
|
||
public state: ITagInputState = { inputValue: "", isInputFocused: false }; | ||
|
||
private inputElement: HTMLInputElement; | ||
private refHandlers = { | ||
input: (ref: HTMLInputElement) => { | ||
this.inputElement = ref; | ||
const refHandler = this.props.inputProps.ref; | ||
if (Utils.isFunction(refHandler)) { | ||
refHandler(ref); | ||
} | ||
}, | ||
}; | ||
|
||
public render() { | ||
const { inputProps, tagProps, values } = this.props; | ||
|
||
const classes = classNames(Classes.INPUT, "pt-tag-input", { | ||
[Classes.ACTIVE]: this.state.isInputFocused, | ||
}, this.props.className); | ||
|
||
const tags = values.map((tag, i) => { | ||
const props = Utils.isFunction(tagProps) ? tagProps(tag, i) : tagProps; | ||
return <Tag data-tag-index={i} key={tag + "__" + i} onRemove={this.handleRemoveTag} {...props}>{tag}</Tag>; | ||
}); | ||
return ( | ||
<div className={classes} onClick={this.handleContainerClick}> | ||
{tags} | ||
<input | ||
value={this.state.inputValue} | ||
{...inputProps} | ||
onBlur={this.handleInputBlur} | ||
onFocus={this.handleInputFocus} | ||
onChange={this.handleInputChange} | ||
onKeyDown={this.handleInputKeyDown} | ||
ref={this.refHandlers.input} | ||
className={classNames("pt-input-invisible", inputProps.className)} | ||
/> | ||
</div> | ||
); | ||
} | ||
|
||
private handleContainerClick = () => { | ||
if (this.inputElement != null) { | ||
this.inputElement.focus(); | ||
} | ||
} | ||
|
||
private handleInputBlur = (event: React.FocusEvent<HTMLInputElement>) => { | ||
this.setState({ isInputFocused: false }); | ||
Utils.safeInvoke(this.props.inputProps.onBlur, event); | ||
} | ||
|
||
private handleInputFocus = (event: React.FocusEvent<HTMLInputElement>) => { | ||
this.setState({ isInputFocused: true }); | ||
Utils.safeInvoke(this.props.inputProps.onFocus, event); | ||
} | ||
|
||
private handleInputChange = (event: React.KeyboardEvent<HTMLInputElement>) => { | ||
this.setState({ inputValue: event.currentTarget.value }); | ||
Utils.safeInvoke(this.props.inputProps.onChange, event); | ||
} | ||
|
||
private handleInputKeyDown = (event: React.KeyboardEvent<HTMLInputElement>) => { | ||
const { value } = event.currentTarget; | ||
if (event.which === Keys.ENTER && value.length > 0) { | ||
Utils.safeInvoke(this.props.onAdd, value); | ||
this.setState({ inputValue: "" }); | ||
} else if (event.which === Keys.BACKSPACE && value.length === 0) { | ||
const lastIndex = this.props.values.length - 1; | ||
Utils.safeInvoke(this.props.onRemove, this.props.values[lastIndex], lastIndex); | ||
} | ||
Utils.safeInvoke(this.props.inputProps.onKeyDown, event); | ||
} | ||
|
||
private handleRemoveTag = (event: React.MouseEvent<HTMLSpanElement>) => { | ||
// using data attribute to simplify callback logic -- one handler for all children | ||
const index = +event.currentTarget.parentElement.getAttribute("data-tag-index"); | ||
Utils.safeInvoke(this.props.onRemove, this.props.values[index], index); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,3 +4,4 @@ | |
|
||
import "./inputListTests"; | ||
import "./selectTests"; | ||
import "./tagInputTests"; |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💥
HTMLAttributes
does not includeref
so it avoids the nasty{ ref, ...htmlInputProps }
spread we've had to do! i'll go refactor other usages separately.