Feat/chips input v2 #1490
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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,7 @@ | ||
| import { ChipProps, ChipsInputProps } from './index'; | ||
| export declare const isContainsInvalid: (chips: Array<ChipProps>) => boolean; | ||
| export declare const getValidationBasedColor: (chips: Array<ChipProps>, defaultChip?: ChipProps | undefined) => string; | ||
| export declare const getCounterTextColor: (stateChips: Array<ChipProps>, props: ChipsInputProps) => string; | ||
| export declare const getCounterText: (count: number, maxLength: number) => string; | ||
| export declare const getChipDismissColor: (chip: ChipProps, isSelected: boolean, defaultChipProps?: ChipProps | undefined) => string; | ||
| export declare const isDisabled: (props: ChipsInputProps) => boolean; |
This file contains hidden or 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,149 @@ | ||
| import _ from 'lodash'; | ||
| import React, { Component } from 'react'; | ||
| import { ViewStyle, TextInput, NativeSyntheticEvent, TextInputKeyPressEventData, ScrollView, ScrollViewProps, TextInputProps as RNTextInputProps } from 'react-native'; | ||
| import { BaseComponentInjectedProps, TypographyModifiers } from '../../commons/new'; | ||
| import { ChipProps as ExternalChipProp } from '../chip'; | ||
| import { TextFieldProps } from '../../../typings/components/Inputs'; | ||
| declare type ChipType = string | boolean | any; | ||
| export declare type ChipProps = ExternalChipProp & { | ||
| invalid?: boolean; | ||
| }; | ||
| export declare type ChipsInputProps = TypographyModifiers & TextFieldProps & { | ||
| /** | ||
| * DEPRECATED: use chips instead. list of tags. can be string boolean or custom object when implementing getLabel | ||
| */ | ||
| tags?: Array<ChipType>; | ||
| /** | ||
| * list of tags. can be string boolean or custom object when implementing getLabel | ||
| */ | ||
| chips?: Array<ChipProps>; | ||
| /** | ||
| * Style your chips | ||
| */ | ||
| defaultChipProps?: ChipProps; | ||
| /** | ||
| * callback for extracting the label out of the tag item | ||
| */ | ||
| getLabel?: (tag: ChipType) => any; | ||
| /** | ||
| * callback for custom rendering tag item | ||
| */ | ||
| renderTag?: (tag: ChipType, index: number, shouldMarkTag: boolean, label: string) => React.ReactElement; | ||
| /** | ||
| * callback for onChangeTags event | ||
| */ | ||
| onChangeTags?: () => void; | ||
| /** | ||
| * callback for creating new tag out of input value (good for composing tag object) | ||
| */ | ||
| onCreateTag?: (value: any) => void; | ||
| /** | ||
| * callback for when pressing a tag in the following format (tagIndex, markedTagIndex) => {...} | ||
| */ | ||
| onTagPress?: (index: number, toRemove?: number) => void; | ||
| /** | ||
| * validation message error appears when tag isn't validate | ||
| */ | ||
| validationErrorMessage?: string; | ||
| /** | ||
| * if true, tags *removal* Ux won't be available | ||
| */ | ||
| disableTagRemoval?: boolean; | ||
| /** | ||
| * if true, tags *adding* Ux (i.e. by 'submitting' the input text) won't be available | ||
| */ | ||
| disableTagAdding?: boolean; | ||
| /** | ||
| * custom styling for the component container | ||
| */ | ||
| containerStyle?: ViewStyle; | ||
| /** | ||
| * custom styling for the tag item | ||
| */ | ||
| tagStyle?: ViewStyle; | ||
| /** | ||
| * custom styling for the text input | ||
| */ | ||
| inputStyle?: RNTextInputProps['style']; | ||
| /** | ||
| * should hide input underline | ||
| */ | ||
| hideUnderline?: boolean; | ||
| /** | ||
| * Maximum numbers of chips | ||
| */ | ||
| maxLength?: number; | ||
| /** | ||
| * Chips with maxHeigh is inside a scrollView | ||
| */ | ||
| scrollViewProps?: ScrollViewProps; | ||
| /** | ||
| * Chips inside a ScrollView | ||
| */ | ||
| maxHeight?: number; | ||
| /** | ||
| * Custom element before the chips, for example 'search' icon, 'To:' label etc' | ||
| */ | ||
| leftElement?: JSX.Element | JSX.Element[]; | ||
| value?: any; | ||
| selectionColor?: string | number; | ||
| }; | ||
| declare type State = { | ||
| value: any; | ||
| chips: Array<ChipType>; | ||
| chipIndexToRemove?: number; | ||
| initialChips?: Array<ChipType>; | ||
| isFocused: boolean; | ||
| }; | ||
| declare type OwnProps = ChipsInputProps & BaseComponentInjectedProps; | ||
| /** | ||
| * @description: Tags input component (chips) | ||
| * @modifiers: Typography | ||
| * @gif: https://github.com/wix/react-native-ui-lib/blob/master/demo/showcase/ChipsInput/ChipsInput.gif?raw=true | ||
| * @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ChipsInputScreen.js | ||
| * @extends: TextField | ||
| */ | ||
| declare class ChipsInput extends Component<OwnProps, State> { | ||
| static displayName: string; | ||
| static onChangeTagsActions: { | ||
| ADDED: string; | ||
| REMOVED: string; | ||
| }; | ||
| input: React.RefObject<TextInput>; | ||
| scrollRef: React.RefObject<ScrollView>; | ||
| constructor(props: OwnProps); | ||
| componentDidMount(): void; | ||
| static getDerivedStateFromProps(nextProps: Readonly<OwnProps>, prevState: State): { | ||
| initialChips: any[] | undefined; | ||
| chips: any[] | undefined; | ||
| } | null; | ||
| addTag: () => void; | ||
| removeMarkedTag(): void; | ||
| markTagIndex: (chipIndex: number) => void; | ||
| onChangeText: _.DebouncedFunc<(value: any) => void>; | ||
| onTagPress(index: number): void; | ||
| isLastTagMarked(): boolean; | ||
| onKeyPress: (event: NativeSyntheticEvent<TextInputKeyPressEventData>) => void; | ||
| getLabel: (item: ChipType) => any; | ||
| onFocus: () => void; | ||
| onBlur: () => void; | ||
| renderLabel(tag: ChipType, shouldMarkTag: boolean): JSX.Element; | ||
| renderTag: (tag: ChipType, index: number) => JSX.Element; | ||
| renderTagWrapper: (tag: ChipType, index: number) => JSX.Element; | ||
| renderNewChip: () => JSX.Element[]; | ||
| renderTitleText: () => "" | JSX.Element | undefined; | ||
| renderChips: () => JSX.Element[]; | ||
| renderCharCounter(): JSX.Element | undefined; | ||
| renderUnderline: () => JSX.Element; | ||
| renderTextInput(): JSX.Element; | ||
| renderChipsContainer: () => JSX.Element; | ||
| render(): JSX.Element; | ||
| blur(): void; | ||
| focus(): void; | ||
| clear(): void; | ||
| } | ||
| export { ChipsInput }; | ||
| declare const _default: React.ComponentClass<ChipsInputProps & { | ||
| useCustomTheme?: boolean | undefined; | ||
| }, any> & typeof ChipsInput; | ||
| export default _default; |
This file contains hidden or 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 hidden or 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,35 @@ | ||
| import {Colors} from '../../style'; | ||
| import {ChipProps, ChipsInputProps} from './index'; | ||
|
|
||
| export const hasInvalidChip = (chips: Array<ChipProps>) => { | ||
| return chips.filter((chip) => chip.invalid === true)[0] !== undefined; | ||
| }; | ||
|
|
||
| export const getValidationBasedColor = (chips: Array<ChipProps>, defaultChip?: ChipProps) => { | ||
| const dismissColor = defaultChip?.dismissColor || Colors.red30; | ||
|
|
||
| return hasInvalidChip(chips) ? dismissColor : Colors.primary; | ||
| }; | ||
|
|
||
| export const getCounterTextColor = (stateChips: Array<ChipProps>, props: ChipsInputProps) => { | ||
| const {maxLength} = props; | ||
| if (isDisabled(props)) { | ||
| return Colors.grey50; | ||
| } | ||
| return maxLength && stateChips.length >= maxLength ? Colors.red30 : Colors.grey30; | ||
| }; | ||
|
|
||
| export const getCounterText = (count: number, maxLength: number) => { | ||
| return `${Math.min(count, maxLength)} / ${maxLength}`; | ||
| }; | ||
|
|
||
| export const getChipDismissColor = (chip: ChipProps, isSelected: boolean, defaultChipProps?: ChipProps) => { | ||
Inbal-Tish marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| const dismissColor = defaultChipProps?.dismissColor || Colors.white; | ||
| return !chip.invalid ? dismissColor : isSelected ? Colors.red10 : Colors.red30; | ||
| }; | ||
|
|
||
| export const isDisabled = (props: ChipsInputProps) => { | ||
| const {disableTagRemoval, editable} = props; | ||
| return disableTagRemoval || editable === false; | ||
| }; | ||
|
|
||
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.
Uh oh!
There was an error while loading. Please reload this page.