CocoaPods trunk is moving to be read-only. Read more on the blog, there are 12 months to go.
{"payload":{"allShortcutsEnabled":false,"fileTree":{"docs/v1.0.10":{"items":[{"name":"CHANGELOG","path":"docs/v1.0.10/CHANGELOG","contentType":"directory"},{"name":"InteractiveLayers.md","path":"docs/v1.0.10/InteractiveLayers.md","contentType":"file"},{"name":"MapplsAPICore.md","path":"docs/v1.0.10/MapplsAPICore.md","contentType":"file"},{"name":"MapplsAPIKit.md","path":"docs/v1.0.10/MapplsAPIKit.md","contentType":"file"},{"name":"MapplsAnnotationExtension.md","path":"docs/v1.0.10/MapplsAnnotationExtension.md","contentType":"file"},{"name":"MapplsDirectionUI.md","path":"docs/v1.0.10/MapplsDirectionUI.md","contentType":"file"},{"name":"MapplsDrivingRangePlugin.md","path":"docs/v1.0.10/MapplsDrivingRangePlugin.md","contentType":"file"},{"name":"MapplsFeedbackKit.md","path":"docs/v1.0.10/MapplsFeedbackKit.md","contentType":"file"},{"name":"MapplsFeedbackUIKit.md","path":"docs/v1.0.10/MapplsFeedbackUIKit.md","contentType":"file"},{"name":"MapplsGeoanalytics.md","path":"docs/v1.0.10/MapplsGeoanalytics.md","contentType":"file"},{"name":"MapplsGeofenceUI.md","path":"docs/v1.0.10/MapplsGeofenceUI.md","contentType":"file"},{"name":"MapplsIntouch.md","path":"docs/v1.0.10/MapplsIntouch.md","contentType":"file"},{"name":"MapplsMap.md","path":"docs/v1.0.10/MapplsMap.md","contentType":"file"},{"name":"MapplsMapStyle.md","path":"docs/v1.0.10/MapplsMapStyle.md","contentType":"file"},{"name":"MapplsNearbyUI.md","path":"docs/v1.0.10/MapplsNearbyUI.md","contentType":"file"},{"name":"MapplsPinStrategy.md","path":"docs/v1.0.10/MapplsPinStrategy.md","contentType":"file"},{"name":"MapplsTrafficVectorTileOverlay.md","path":"docs/v1.0.10/MapplsTrafficVectorTileOverlay.md","contentType":"file"},{"name":"MapplsUIWidgets.md","path":"docs/v1.0.10/MapplsUIWidgets.md","contentType":"file"},{"name":"Predictive-Route-APIs.md","path":"docs/v1.0.10/Predictive-Route-APIs.md","contentType":"file"},{"name":"README.md","path":"docs/v1.0.10/README.md","contentType":"file"},{"name":"RasterCatalouge.md","path":"docs/v1.0.10/RasterCatalouge.md","contentType":"file"},{"name":"Regions.md","path":"docs/v1.0.10/Regions.md","contentType":"file"}],"totalCount":22},"docs":{"items":[{"name":"v1.0.0","path":"docs/v1.0.0","contentType":"directory"},{"name":"v1.0.1","path":"docs/v1.0.1","contentType":"directory"},{"name":"v1.0.10","path":"docs/v1.0.10","contentType":"directory"},{"name":"v1.0.11","path":"docs/v1.0.11","contentType":"directory"},{"name":"v1.0.12","path":"docs/v1.0.12","contentType":"directory"},{"name":"v1.0.13","path":"docs/v1.0.13","contentType":"directory"},{"name":"v1.0.14","path":"docs/v1.0.14","contentType":"directory"},{"name":"v1.0.15","path":"docs/v1.0.15","contentType":"directory"},{"name":"v1.0.16","path":"docs/v1.0.16","contentType":"directory"},{"name":"v1.0.2","path":"docs/v1.0.2","contentType":"directory"},{"name":"v1.0.3","path":"docs/v1.0.3","contentType":"directory"},{"name":"v1.0.4","path":"docs/v1.0.4","contentType":"directory"},{"name":"v1.0.5","path":"docs/v1.0.5","contentType":"directory"},{"name":"v1.0.6","path":"docs/v1.0.6","contentType":"directory"},{"name":"v1.0.7","path":"docs/v1.0.7","contentType":"directory"},{"name":"v1.0.8","path":"docs/v1.0.8","contentType":"directory"},{"name":"v1.0.9","path":"docs/v1.0.9","contentType":"directory"}],"totalCount":17},"":{"items":[{"name":"MapplsSDKDemo.xcodeproj","path":"MapplsSDKDemo.xcodeproj","contentType":"directory"},{"name":"MapplsSDKDemo","path":"MapplsSDKDemo","contentType":"directory"},{"name":"docs","path":"docs","contentType":"directory"},{"name":"LICENSE.md","path":"LICENSE.md","contentType":"file"},{"name":"Mappls.podspec","path":"Mappls.podspec","contentType":"file"},{"name":"Podfile","path":"Podfile","contentType":"file"},{"name":"README.md","path":"README.md","contentType":"file"},{"name":"Version-History.md","path":"Version-History.md","contentType":"file"}],"totalCount":8}},"fileTreeProcessingTime":6.768578,"foldersToFetch":[],"reducedMotionEnabled":null,"repo":{"id":491393896,"defaultBranch":"main","name":"mappls-ios-sdk","ownerLogin":"mappls-api","currentUserCanPush":false,"isFork":false,"isEmpty":false,"createdAt":"2022-05-12T06:38:36.000Z","ownerAvatar":"https://avatars.githubusercontent.com/u/98086022?v=4","public":true,"private":false,"isOrgOwned":true},"symbolsExpanded":false,"treeExpanded":true,"refInfo":{"name":"main","listCacheKey":"v0:1695384624.0","canEdit":false,"refType":"branch","currentOid":"22caf475421bd2bd586a8d842b21587315f7613f"},"path":"docs/v1.0.10/MapplsUIWidgets.md","currentUser":null,"blob":{"rawLines":null,"stylingDirectives":null,"csv":null,"csvError":null,"dependabotInfo":{"showConfigurationBanner":false,"configFilePath":null,"networkDependabotPath":"/mappls-api/mappls-ios-sdk/network/updates","dismissConfigurationNoticePath":"/settings/dismiss-notice/dependabot_configuration_notice","configurationNoticeDismissed":null,"repoAlertsPath":"/mappls-api/mappls-ios-sdk/security/dependabot","repoSecurityAndAnalysisPath":"/mappls-api/mappls-ios-sdk/settings/security_analysis","repoOwnerIsOrg":true,"currentUserCanAdminRepo":false},"displayName":"MapplsUIWidgets.md","displayUrl":"https://github.com/mappls-api/mappls-ios-sdk/blob/main/docs/v1.0.10/MapplsUIWidgets.md?raw=true","headerInfo":{"blobSize":"35.8 KB","deleteInfo":{"deleteTooltip":"You must be signed in to make or propose changes"},"editInfo":{"editTooltip":"You must be signed in to make or propose changes"},"ghDesktopPath":"https://desktop.github.com","gitLfsPath":null,"onBranch":true,"shortPath":"0d7c7ce","siteNavLoginPath":"/login?return_to=https%3A%2F%2Fgithub.com%2Fmappls-api%2Fmappls-ios-sdk%2Fblob%2Fmain%2Fdocs%2Fv1.0.10%2FMapplsUIWidgets.md","isCSV":false,"isRichtext":true,"toc":[{"level":1,"text":"MapplsUIWidgets - UI Components SDK for iOS","anchor":"mapplsuiwidgets---ui-components-sdk-for-ios","htmlText":"MapplsUIWidgets - UI Components SDK for iOS"},{"level":2,"text":"Introduction","anchor":"introduction","htmlText":"Introduction"},{"level":3,"text":"Dependencies","anchor":"dependencies","htmlText":"Dependencies"},{"level":2,"text":"Installation","anchor":"installation","htmlText":"Installation"},{"level":3,"text":"Version History","anchor":"version-history","htmlText":"Version History"},{"level":2,"text":"Authorization","anchor":"authorization","htmlText":"Authorization"},{"level":3,"text":"MapplsAPICore","anchor":"mapplsapicore","htmlText":"MapplsAPICore"},{"level":2,"text":"Autocomplete","anchor":"autocomplete","htmlText":"Autocomplete"},{"level":3,"text":"Add an autocomplete UI control","anchor":"add-an-autocomplete-ui-control","htmlText":"Add an autocomplete UI control"},{"level":3,"text":"Add a full-screen control","anchor":"add-a-full-screen-control","htmlText":"Add a full-screen control"},{"level":4,"text":"SwiftUI Full Screen Control","anchor":"swiftui-full-screen-control","htmlText":"SwiftUI Full Screen Control"},{"level":5,"text":"Create Autosuggest View Controller","anchor":"create-autosuggest-view-controller","htmlText":"Create Autosuggest View Controller"},{"level":5,"text":"Respond To Autosuggest Events","anchor":"respond-to-autosuggest-events","htmlText":"Respond To Autosuggest Events"},{"level":3,"text":"Add a results controller","anchor":"add-a-results-controller","htmlText":"Add a results controller"},{"level":4,"text":"Add a search bar to the navigation bar","anchor":"add-a-search-bar-to-the-navigation-bar","htmlText":"Add a search bar to the navigation bar"},{"level":4,"text":"Add a search bar to the top of a view","anchor":"add-a-search-bar-to-the-top-of-a-view","htmlText":"Add a search bar to the top of a view"},{"level":3,"text":"Use a table data source","anchor":"use-a-table-data-source","htmlText":"Use a table data source"},{"level":3,"text":"Get place predictions programmatically","anchor":"get-place-predictions-programmatically","htmlText":"Get place predictions programmatically"},{"level":3,"text":"MapplsAutocompleteFilter","anchor":"mapplsautocompletefilter","htmlText":"MapplsAutocompleteFilter"},{"level":4,"text":"Parameters:","anchor":"parameters","htmlText":"Parameters:"},{"level":3,"text":"Favourite Places","anchor":"favourite-places","htmlText":"Favourite Places"},{"level":2,"text":"Place Picker View","anchor":"place-picker-view","htmlText":"Place Picker View"},{"level":3,"text":"PlacePickerViewDelegate","anchor":"placepickerviewdelegate","htmlText":"PlacePickerViewDelegate"},{"level":3,"text":"Customize Place Picker","anchor":"customize-place-picker","htmlText":"Customize Place Picker"},{"level":2,"text":"Autocomplete Attribution Appearance","anchor":"autocomplete-attribution-appearance","htmlText":"Autocomplete Attribution Appearance"},{"level":3,"text":"MapplsAttributionsSettings","anchor":"mapplsattributionssettings","htmlText":"MapplsAttributionsSettings"},{"level":4,"text":"Parameters:","anchor":"parameters-1","htmlText":"Parameters:"},{"level":2,"text":"Our many happy customers:","anchor":"our-many-happy-customers","htmlText":"Our many happy customers:"}],"lineInfo":{"truncatedLoc":"810","truncatedSloc":"557"},"mode":"file"},"image":false,"isCodeownersFile":null,"isPlain":false,"isValidLegacyIssueTemplate":false,"issueTemplateHelpUrl":"https://docs.github.com/articles/about-issue-and-pull-request-templates","issueTemplate":null,"discussionTemplate":null,"language":"Markdown","languageID":222,"large":false,"loggedIn":false,"newDiscussionPath":"/mappls-api/mappls-ios-sdk/discussions/new","newIssuePath":"/mappls-api/mappls-ios-sdk/issues/new","planSupportInfo":{"repoIsFork":null,"repoOwnedByCurrentUser":null,"requestFullPath":"/mappls-api/mappls-ios-sdk/blob/main/docs/v1.0.10/MapplsUIWidgets.md","showFreeOrgGatedFeatureMessage":null,"showPlanSupportBanner":null,"upgradeDataAttributes":null,"upgradePath":null},"publishBannersInfo":{"dismissActionNoticePath":"/settings/dismiss-notice/publish_action_from_dockerfile","dismissStackNoticePath":"/settings/dismiss-notice/publish_stack_from_file","releasePath":"/mappls-api/mappls-ios-sdk/releases/new?marketplace=true","showPublishActionBanner":false,"showPublishStackBanner":false},"rawBlobUrl":"https://github.com/mappls-api/mappls-ios-sdk/raw/main/docs/v1.0.10/MapplsUIWidgets.md","renderImageOrRaw":false,"richText":" The MapplsUIWidgets SDK for iOS allows you can build rich apps by quickly implement reday made UI components. Currently this SDK have a widget for Searching a place using AutoSuggest API. This library depends upon several Mappls's own libraries. All dependent libraries will be automatically installed using CocoaPods. Below are list of dependencies which are required to run this SDK: This library is available through On running It is required to set Mappls keys to use any Mappls SDK. Please refer the documentation here. The autocomplete service in the SDK for iOS returns place predictions in response to user search queries. As the user types, the autocomplete service returns suggestions for places such as businesses, addresses and points of interest. You can add autocomplete to your app in the following ways: Add an autocomplete UI control to save development time and ensure a consistent user experience. Get place predictions programmatically to create a customized user experience. The autocomplete UI control is a search dialog with built-in autocomplete functionality. As a user enters search terms, the control presents a list of predicted places to choose from. When the user makes a selection, a MapplsAtlasSuggestion instance is returned, which your app can then use to get details about the selected place. Use the full-screen control when you want a modal context, where the autocomplete UI temporarily replaces the UI of your app until the user has made their selection. This functionality is provided by the MapplsAutocompleteViewController class. When the user selects a place, your app receives a callback. To add a full-screen control to your app: The following example demonstrates one possible way to launch MapplsAutocompleteViewController in response to the user tapping on a button. In order to respond to Autosuggest events, for example perform an action on selecting a result from Autosuggest's results. In SwiftUI, a Coordinator can be used with delegates, data sources, and user events. The UIViewControllerRepresentable protocol defines makeCoordinator() method which creates coordinator instance. Add the following code to declare coordinator class: And then add the following method to the ¨C14C: ¨C72C Reference coordinator is set using below code in above class. Use a results controller when you want more control over the text input UI. The results controller dynamically toggles the visibility of the results list based on input UI focus. To add a results controller to your app: There are several ways to place the search bar of a UISearchController into your app's UI: The following code example demonstrates adding a results controller, adding the searchBar to the navigation bar, and handling the user's selection: ¨C83C For the search bar to display properly, your app's view controller must be enclosed within a UINavigationController. The following code example shows adding the searchBar to the top of a view. You can use the MapplsAutocompleteTableDataSource class to drive the table view of a UISearchDisplayController. To use MapplsAutocompleteTableDataSource to display a search controller: The following code example demonstrates using the MapplsAutocompleteTableDataSource class to drive the table view of a UISearchDisplayController. You can create a custom search UI as an alternative to the UI provided by the autocomplete widget. To do this, your app must get place predictions programmatically. Your app can get a list of predicted place names and/or addresses by using Mappls's library ¨C15C. For more information Goto. This class represents a set of restrictions that may be applied to autocomplete requests. This allows customization of autocomplete suggestions to only those places that are of interest. ¨C92C A location to use as a hint when looking up the specified address. This property prioritizes results that are close to a specific location, which is typically the user’s current location. If the value of this property is nil – which it is by default – no specific location is prioritized. ¨C93C Zoom level to a location to use as a hint when looking up the specified address. ¨C94C It allows to get tokenize address in response. By default its value is ¨C16C. If value true is passed then only in response of MapplsAtlasSuggestion addressTokens will be recieved which is of type MapplsAddressTokens ¨C95C On basis of this only specific type of Places in response will be returned. Its data type is MapplsPodType which is derived from MapplsAPIKit ¨C96C On basis of this only specific type of response returned. This can be set either an object of MapplsMapplsPinFilter or MapplsBoundsFilter. Which are derived from MapplsAPIKit ¨C97C This is used to bias your search related to country region. Its datatype is MapplsRegionType(from MapplsAPIKit). By default it sets to India region only.\nCurrently supported countries are Sri-Lanka, India, Bhutan, Bangladesh, Nepal. Default is India if none is provided Favourite or Custom Places can be set to show in result of Autosuggest. By default on searching by entering any text favourites will also be filtered. Filtering can be disabled by setting value ¨C17C of global boolean property ¨C18C. By disabling it means it will always show favourites in results. By default maximum two favourites will be shown in results. This can be configured by setting value of property ¨C19C. Its default value is 2. Minimum value can be 0 and maximum can be 10. Below is line of code can be used to set favourite places. Callback of selected favourite item can be handled using different delegate methods. See here. ¨C98C The Place Picker View is a UIView component that allows a user to pick a Place using an interactive map. Users can select a location which from center of map after succesfully reverse geocoding that location. ¨C20C is class whose instance can be created and can be added to ViewController. Below is sample code to understand: ¨C100C As from above sample code ¨C21C is a protocol class which provides different delegate methods which can be used according to requirements. On adding instance of ¨C22C it will load a default view with a map marker image on map But default view can be modified with help of some properties which are described as below: ¨C102C View of marker on map can be ovrriden by using property 'markerView'. This is type of UIView so it can accept custom designed view and UIImageView as well. ¨C104C A shadow of marker is shows by defualt on dragging map. Visibility of this shadow can be changed by using property 'isMarkerShadowViewHidden'. ¨C106C Background color of search button can be changed by using property 'searchButtonBackgroundColor'. ¨C108C Image of search button can be changed by using property 'searchButtonImage'. ¨C110C Visibility of search button can be changed by using property 'isSearchButtonHidden'. ¨C112C Font color of label of name of place can be changed by using property 'placeNameLabelTextColor'. ¨C114C Font color of label of address of place can be changed by using property 'addressLabelTextColor'. ¨C116C Font color of titile of button of select a location to pick can be changed by using property 'pickerButtonTitleColor'. ¨C118C Background color of button of select a location to pick can be changed by using property 'pickerButtonBackgroundColor'. ¨C120C Title of button of select a location to pick can be changed by using property 'pickerButtonTitle'. ¨C122C Font color of label of tip info at bottom can be changed by using property 'infoLabelTextColor'. ¨C124C Background color of container of label of tip info at bottom can be changed by using property 'infoBottomViewBackgroundColor'. ¨C126C Background color of container of location info at bottom can be changed by using property 'placeDetailsViewBackgroundColor'. ¨C128C Visibility of tip info at bottom can be changed by using property 'isBottomInfoViewHidden'. ¨C130C Visibility of container of location info at bottom can be changed by using property 'isBottomPlaceDetailViewHidden'. ¨C132C Initial location of place picker can be set by setting center of map but it will also required to set value of property 'isInitializeWithCustomLocation' to true. A class ¨C23C is exist which represents a set of settings that can be applied to autocomplete to control appearance (Content Length, Size, Horizontal Content Alignment and Vertical Placement) of attribution. Appearance of attribution on can be controlled by different properties of ¨C24C. ¨C134C Size of attribution can be controlled by setting different values of this property. It is type of an enum ¨C25C. Which can be set to ¨C26C, ¨C27C or ¨C28C. By default it's value is ¨C29C. ¨C135C Horizontal alignment of content of attribution can be controlled by setting different values of this property. It is type of an enum ¨C30C. Which can be set to ¨C31C, ¨C32C or ¨C33C. By default it's value is ¨C34C. ¨C136C Placement (either before or after of autocomplete's results) of attribution can be controlled by setting different values of this property. It is type of an enum ¨C35C. Which can be set to ¨C36C or ¨C37C. By default it's value is ¨C38C. A property ¨C39C of type ¨C40C is exists in each class ¨C41C, ¨C42C, ¨C43C and ¨C44C whose values can be set in different scenarios accordingly. Code snippet to configure appearance of attribution in ¨C45C is below: Code snippet to configure appearance of attribution of Autocomplete in ¨C46C is below: For any queries and support, please contact: Email us at [email protected] MapplsUIWidgets - UI Components SDK for iOS
\nIntroduction
\nDependencies
\nInstallation
\nCocoaPods. To install, simply add the following line to your podfile:pod 'MapplsUIWidgets', '1.0.3'
pod install command it will automatically download and setup MapplsUIWidgets and dependent frameworks.Version History
\n\n\n
\n\n \n\n\nVersion \nDated \nDescription \n\n \n \n1.0.302 June, 2023 \nAdded functionality to show favourites/custom places in Autosuggest Widget. Added related callbacks etc. \n\n \n¨C5C \n02 May, 2023 \nAdded ¨C6C property in ¨C7C class and added ¨C8C property in ¨C9C class. \n\n \n¨C10C \n03 Sept, 2022 \nAdded hyperLocal property. \n\n \n\n¨C11C \n12 June, 2022 \nInitial Mappls UIWidget Release. \nAuthorization
\nMapplsAPICore
\nAutocomplete
\n\nAdd an autocomplete UI control
\n\n¨C53C\n¨C54C\n¨C55C\n
\nAdd a full-screen control
\n\n¨C56C\n¨C57C\n¨C58C\n¨C59C\n¨C60C\n¨C61C\n¨C62C\n
\nSwiftUI Full Screen Control
\nCreate Autosuggest View Controller
\n\n¨C64C\n¨C65C\n¨C66C\n¨C67C\n¨C68C\n¨C69C\n
\nRespond To Autosuggest Events
\nAdd a results controller
\n\n¨C74C\n¨C75C\n¨C76C\n¨C77C\n¨C78C\n¨C79C\n
\n\n¨C80C\n¨C81C\n
\nAdd a search bar to the navigation bar
\nAdd a search bar to the top of a view
\nUse a table data source
\n\n¨C85C\n¨C86C\n¨C87C\n¨C88C\n¨C89C\n¨C90C\n
\nGet place predictions programmatically
\nMapplsAutocompleteFilter
\nParameters:
\nFavourite Places
\nPlace Picker View
\n\n\nPlacePickerViewDelegate
\nCustomize Place Picker
\nAutocomplete Attribution Appearance
\nMapplsAttributionsSettings
\nParameters:
\nOur many happy customers:
\n\n
\n\nSupport\nNeed support? contact us!