Skip to content

Commit

Permalink
README is updated
Browse files Browse the repository at this point in the history
  • Loading branch information
@WrathChaos
WrathChaos committed Aug 11, 2020
1 parent 206d6ba commit 622a076
Showing 1 changed file with 108 additions and 38 deletions.
146 changes: 108 additions & 38 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -160,43 +160,43 @@ export default class Test extends Component {

### Configuration - Props

| Property | Type | Default | Description |
| ------------------- | :-------: | :---------------: | ----------------------------------------------------------------------------------------------------- |
| autoFocus | boolean | true | change the autoFocus mode for the TextInput |
| backgroundColor | color | #fff | change the background color of the search bar |
| borderRadius | number | 10 | change the border radius of the search bar
| cancelButtonDisable | boolean | false | disable cancel button component |
| cancelComponent | component | component | set your own component instead of cancel component |
| cancelIconColor | color | #b3b6c3 | change the cancel icon color |
| cancelIconComponent | component | Icon | set your own component instead of Icon for the cancel component (right component) |
| cancelIconName | string | clear | change the cancel icon |
| cancelIconSize | number | 23 | change the cancel icon size |
| cancelIconType | string | MaterialIcons | change the cancel icon style |
| fontColor | color | #b3b6c3 | change the font color |
| fontFamily | string | undefined | set the font family for the text input in the search bar |
| fontSize | number | 13 | change the font size |
| height | string / number | 35 | change the height of the search bar
| iconColor | color | #807DE7 | change the icon color |
| iconComponent | component | Icon | set your own component instead of Icon |
| iconName | string | search | change the icon |
| iconSize | number | 20 | change the icon size |
| iconType | string | Octicons | change the icon style |
| noExtraMargin | boolean | false | remove extra padding on iPhone X devices |
| onChangeText | function | function | set your own function for the onChangeText logic |
| onPress | function | function | set your own function for the onPress functionality |
| onPressCancel | function | function | set your own function for the cancel button's onPress functionality |
| onPressToFocus | boolean | false | when enable it, onPress will automatically focus on the TextInput and opens the soft virtual keyboard |
| placeholder | string | null | set your own placeholder string |
| shadowColor | color | #757575 | change the shadow color |
| shadowStyle | style | shadow style | set your own shadow style |
| spinnerColor | color | #fdfdfd | change the spinner color |
| spinnerSize | number | default | change the spinner size |
| spinnerType | string | Circle | change the spinner type |
| spinnerVisibility | boolean | false | change the spinner visibility |
| textInputComponent | component | Text OR TextInput | set your own component instead of Text OR TextInput for the center component |
| textInputDisable | boolean | false | disable the text input, and Text component will be available instead |
| textInputValue | string | value | set the value of the text input |
| width | string / number | ScreenWidth*0.93 | change the width of the search bar
| Property | Type | Default | Description |
| ------------------- | :-------------: | :---------------: | ----------------------------------------------------------------------------------------------------- |
| autoFocus | boolean | true | change the autoFocus mode for the TextInput |
| backgroundColor | color | #fff | change the background color of the search bar |
| borderRadius | number | 10 | change the border radius of the search bar |
| cancelButtonDisable | boolean | false | disable cancel button component |
| cancelComponent | component | component | set your own component instead of cancel component |
| cancelIconColor | color | #b3b6c3 | change the cancel icon color |
| cancelIconComponent | component | Icon | set your own component instead of Icon for the cancel component (right component) |
| cancelIconName | string | clear | change the cancel icon |
| cancelIconSize | number | 23 | change the cancel icon size |
| cancelIconType | string | MaterialIcons | change the cancel icon style |
| fontColor | color | #b3b6c3 | change the font color |
| fontFamily | string | undefined | set the font family for the text input in the search bar |
| fontSize | number | 13 | change the font size |
| height | string / number | 35 | change the height of the search bar |
| iconColor | color | #807DE7 | change the icon color |
| iconComponent | component | Icon | set your own component instead of Icon |
| iconName | string | search | change the icon |
| iconSize | number | 20 | change the icon size |
| iconType | string | Octicons | change the icon style |
| noExtraMargin | boolean | false | remove extra padding on iPhone X devices |
| onChangeText | function | function | set your own function for the onChangeText logic |
| onPress | function | function | set your own function for the onPress functionality |
| onPressCancel | function | function | set your own function for the cancel button's onPress functionality |
| onPressToFocus | boolean | false | when enable it, onPress will automatically focus on the TextInput and opens the soft virtual keyboard |
| placeholder | string | null | set your own placeholder string |
| shadowColor | color | #757575 | change the shadow color |
| shadowStyle | style | shadow style | set your own shadow style |
| spinnerColor | color | #fdfdfd | change the spinner color |
| spinnerSize | number | default | change the spinner size |
| spinnerType | string | Circle | change the spinner type |
| spinnerVisibility | boolean | false | change the spinner visibility |
| textInputComponent | component | Text OR TextInput | set your own component instead of Text OR TextInput for the center component |
| textInputDisable | boolean | false | disable the text input, and Text component will be available instead |
| textInputValue | string | value | set the value of the text input |
| width | string / number | ScreenWidth\*0.93 | change the width of the search bar |

## Expo Compatibility

Expand Down Expand Up @@ -243,14 +243,80 @@ constructor() {

# Changelog

## [1.3.0](https://github.com/WrathChaos/react-native-dynamic-search-bar/tree/1.3.0) (2020-08-11)

[Full Changelog](https://github.com/WrathChaos/react-native-dynamic-search-bar/compare/1.2.1...1.3.0)

- Finally `height` and `width` props are working properly. 🔥
- TextInput's `height` bug is fixed. (That ugly thing is finally fixed) 🥳
- Better typescript refactoring is incoming with the next version ⏳

**Closed issues:**

- Just Doesn't Work And Contains NODE_MODULES [\#32](https://github.com/WrathChaos/react-native-dynamic-search-bar/issues/32)
- Documentation: Missing Props [\#27](https://github.com/WrathChaos/react-native-dynamic-search-bar/issues/27)

**Merged pull requests:**

- Bump lodash from 4.17.15 to 4.17.19 in /example [\#36](https://github.com/WrathChaos/react-native-dynamic-search-bar/pull/36) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump @types/react-native from 0.62.18 to 0.63.0 [\#35](https://github.com/WrathChaos/react-native-dynamic-search-bar/pull/35) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
- Bump react-native-vector-icons from 6.7.0 to 7.0.0 [\#34](https://github.com/WrathChaos/react-native-dynamic-search-bar/pull/34) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
- feat: add documentation to missing properties of internal components that are [\#33](https://github.com/WrathChaos/react-native-dynamic-search-bar/pull/33) ([tiagostutz](https://github.com/tiagostutz))
- Bump react-native-dynamic-vector-icons from 0.2.2 to 1.0.0 [\#31](https://github.com/WrathChaos/react-native-dynamic-search-bar/pull/31) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))

## [1.2.1](https://github.com/WrathChaos/react-native-dynamic-search-bar/tree/1.2.1) (2020-06-21)

[Full Changelog](https://github.com/WrathChaos/react-native-dynamic-search-bar/compare/1.2.0...1.2.1)

## [1.2.0](https://github.com/WrathChaos/react-native-dynamic-search-bar/tree/1.2.0) (2020-05-29)

[Full Changelog](https://github.com/WrathChaos/react-native-dynamic-search-bar/compare/1.1.0...1.2.0)

## [1.1.0](https://github.com/WrathChaos/react-native-dynamic-search-bar/tree/1.1.0) (2020-05-25)

[Full Changelog](https://github.com/WrathChaos/react-native-dynamic-search-bar/compare/1.0.4...1.1.0)

## [1.0.4](https://github.com/WrathChaos/react-native-dynamic-search-bar/tree/1.0.4) (2020-05-24)

[Full Changelog](https://github.com/WrathChaos/react-native-dynamic-search-bar/compare/1.0.2...1.0.4)

**Fixed bugs:**

- shadowStyle prop is not passed through [\#26](https://github.com/WrathChaos/react-native-dynamic-search-bar/issues/26)

**Closed issues:**

- NPM error trying to install expo version [\#30](https://github.com/WrathChaos/react-native-dynamic-search-bar/issues/30)
- Add instructions on how to run the Example [\#28](https://github.com/WrathChaos/react-native-dynamic-search-bar/issues/28)

**Merged pull requests:**

- Adds README with instructions on how to run the example [\#29](https://github.com/WrathChaos/react-native-dynamic-search-bar/pull/29) ([tiagostutz](https://github.com/tiagostutz))

## [1.0.2](https://github.com/WrathChaos/react-native-dynamic-search-bar/tree/1.0.2) (2020-04-23)

[Full Changelog](https://github.com/WrathChaos/react-native-dynamic-search-bar/compare/1.0.1...1.0.2)

**Fixed bugs:**

- Expo version is not found [\#25](https://github.com/WrathChaos/react-native-dynamic-search-bar/issues/25)

**Merged pull requests:**

- Bump @types/react-native from 0.60.31 to 0.62.2 [\#24](https://github.com/WrathChaos/react-native-dynamic-search-bar/pull/24) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))

## [1.0.1](https://github.com/WrathChaos/react-native-dynamic-search-bar/tree/1.0.1) (2020-04-11)

[Full Changelog](https://github.com/WrathChaos/react-native-dynamic-search-bar/compare/1.0.0...1.0.1)

- Typescript 😍
- Fully refactored the code base 😇
- Finally version 1.0 🥳
- README is updated with new screenshots

[Full Changelog](https://github.com/WrathChaos/react-native-dynamic-search-bar/releases/tag/1.0.1)
## [1.0.0](https://github.com/WrathChaos/react-native-dynamic-search-bar/tree/1.0.0) (2020-04-11)

[Full Changelog](https://github.com/WrathChaos/react-native-dynamic-search-bar/compare/0.3.1...1.0.0)

**Fixed bugs:**

Expand All @@ -273,6 +339,10 @@ constructor() {

[Full Changelog](https://github.com/WrathChaos/react-native-dynamic-search-bar/compare/0.3.0...0.3.1)

**Implemented enhancements:**

- Adding onSubmitEditing listener [\#14](https://github.com/WrathChaos/react-native-dynamic-search-bar/pull/14) ([abhishekdewan101](https://github.com/abhishekdewan101))

**Closed issues:**

- How do you style the actual searchBar, I want to increase the height of the search bar. I don't see a prop like containerStyle [\#12](https://github.com/WrathChaos/react-native-dynamic-search-bar/issues/12)
Expand Down

0 comments on commit 622a076

Please sign in to comment.