Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/younatics/ynsearch
🔍 Awesome fully customize search view like Pinterest written in Swift 5.0 + Realm support!
https://github.com/younatics/ynsearch
ios pinterest realm realmswift search searchbar swift
Last synced: 15 days ago
JSON representation
🔍 Awesome fully customize search view like Pinterest written in Swift 5.0 + Realm support!
- Host: GitHub
- URL: https://github.com/younatics/ynsearch
- Owner: younatics
- License: mit
- Created: 2017-04-16T05:59:12.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-03-31T08:31:56.000Z (over 5 years ago)
- Last Synced: 2024-10-14T22:21:30.360Z (29 days ago)
- Topics: ios, pinterest, realm, realmswift, search, searchbar, swift
- Language: Swift
- Homepage: https://www.cocoacontrols.com/controls/ynsearch
- Size: 6.09 MB
- Stars: 1,191
- Watchers: 25
- Forks: 104
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# YNSearch + Realm Support
[](https://github.com/sindresorhus/awesome)
[](http://cocoapods.org/pods/YNSearch)
[](https://github.com/Carthage/Carthage)
[](https://github.com/younatics/YNSearch/blob/master/LICENSE)
[](https://travis-ci.org/younatics/YNSearch)
[](http://cocoapods.org/pods/YNSearch)
[](https://developer.apple.com/swift/)
## Updates
See [CHANGELOG](https://github.com/younatics/YNSearch/blob/master/CHANGELOG.md) for details
## Intoduction
🔍 Awesome search view, written in Swift 5.0, appears search view like Pinterest Search view. You can fully customize this library. You can also use this library with Realm! See usage in below
#### See [Highlighter](https://github.com/younatics/Highlighter) for highlight search result
## Requirements
`YNSearch` is written in Swift 5.0. Compatible with iOS 8.0+
## Installation
### Cocoapods
YNSearch is available through [CocoaPods](http://cocoapods.org). To install
it, simply add the following line to your Podfile:
```ruby
pod 'YNSearch'
```
### Carthage
```
github "younatics/YNSearch"
```
## Simple Usage
Set categories (required) and search histories (optional)
```swift
import YNSearch
let demoDatabase = ["Menu", "Animation", "Transition", "TableView", "CollectionView", "Indicator", "Alert", "UIView", "UITextfield", "UITableView", "Swift", "iOS", "Android"]
ynSearch.setCategories(value: demoDatabase)
ynSearch.setSearchHistories(value: demoDatabase)
self.ynSearchinit()
```
Set database (required) and key (required). key will be displayed in `YNSearchListView` You can set your database `[Any]` if you want to customize.
```swift
let database1 = YNDropDownMenu(key: "YNDropDownMenu")
let database2 = YNSearchData(key: "YNSearchData")
let demoDatabase = [database1, database2]
self.initData(database: demoDatabase)
```
Set `YNSearchListView` Delegate
```Swift
func ynSearchListView(_ ynSearchListView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell {
let cell = self.ynSearchView.ynSearchListView.dequeueReusableCell(withIdentifier: YNSearchListViewCell.ID) as! YNSearchListViewCell
if let ynmodel = self.ynSearchView.ynSearchListView.searchResultDatabase[indexPath.row] as? YNSearchModel {
cell.searchLabel.text = ynmodel.key
}
return cell
}
func ynSearchListView(_ ynSearchListView: UITableView, didSelectRowAt indexPath: IndexPath) {
if let ynmodel = self.ynSearchView.ynSearchListView.searchResultDatabase[indexPath.row] as? YNSearchModel, let key = ynmodel.key {
// Call listview clicked based on key
self.ynSearchView.ynSearchListView.ynSearchListViewDelegate?.ynSearchListViewClicked(key: key)
// return object you set in database
self.ynSearchView.ynSearchListView.ynSearchListViewDelegate?.ynSearchListViewClicked(object: self.ynSearchView.ynSearchListView.database[indexPath.row])
// Append Search history
self.ynSearchView.ynSearchListView.ynSearch.appendSearchHistories(value: key)
}
}
```
## Realm Usage
Get your Data with Realm
```Swift
let datas = realm.objects(RealmModel.self)
```
Realm is not collection type so you need to convert it again with `[Any]`type. This will find all string in your RealmModel and show you results.
```Swift
var dataArray = [Any]()
for data in datas {
let searchModel = RealmModel()
searchModel.author = data.author
searchModel.detail = data.detail
searchModel.title = data.title
searchModel.type = data.type
dataArray.append(searchModel)
}
self.initData(database: dataArray)
```
#### I used [Objectification](https://github.com/younatics/Objectification) for accurate search result. This library will get all data in your object and search if for us.
Done!
## View Hierachy
```
YNSearchViewController: Inherit this viewcontroller
|-- YNSearchTextFieldView: YNSearchTextField with cancel button
| |-- YNSearchTextField: Search UITextfield
| |-- cancelButton: Show when YNSearchTextField textFieldDidBeginEditing
|
|-- YNSearchView : get both YNSearchMainView and YNSearchListView
| |-- YNSearchMainView: First view that you can see
| | |-- categoryLabel: Cateogry label
| | |-- [YNCategoryButton]: cateogory buttons
| | |-- searchHistoryLabel: Search history label
| | |-- [YNSearchHistoryView]: history views
| | | |-- [YNSearchHistoryButton]: Search history button
| | | |-- [closeButton]: Close button
| |
| |-- YNSearchListView: UITableview with search result
```
## Custom Usage
set `YNSearchDelegate` if you want callback
```Swift
self.delegate = self
func ynSearchHistoryButtonClicked(text: String) {
print(text)
}
func ynCategoryButtonClicked(text: String) {
print(text)
}
func ynSearchListViewClicked(text: String) {
print(text)
}
func ynSearchListViewClicked(object: YNSearchModel) {
print(object)
}
```
Set `YNCategoryButton` type.
```Swift
self.ynSearchView.ynSearchMainView.setYNCategoryButtonType(type: .colorful)
```
See more usage in demo
#### You can fully customize this `YNSearch` based on view hierachy
## References
#### Please tell me or make pull request if you use this library in your application :)
#### [Highlighter](https://github.com/younatics/Highlighter)
#### [Objectification](https://github.com/younatics/Objectification)
#### [MotionBook](https://github.com/younatics/MotionBook)
## Author
[younatics](https://twitter.com/younatics)
## License
YNSearch is available under the MIT license. See the LICENSE file for more info.