Add feature state functionality to iOS #3858

louwers · 2025-10-04T01:29:47Z

Implements #1698 for iOS. feature-state was already implemented in the core.

Also ports the GLFW example to the Swift-based example app.

FeatureState.mp4

TODO:

Think about the API.
Tests

github-actions · 2025-10-04T01:50:21Z

Bloaty Results (iOS) 🐋

Compared to main

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.1% +19.3Ki  +0.1% +16.0Ki    TOTAL

Full report: https://maplibre-native.s3.eu-central-1.amazonaws.com/bloaty-results-ios/pr-3858-compared-to-main.txt

Copilot

Pull Request Overview

This PR implements feature state functionality for iOS MapLibre, enabling dynamic styling of map features based on user-defined state properties. The implementation adds APIs to set, get, and remove feature state, along with a comprehensive example demonstrating interactive map styling.

Adds feature state management methods to MLNMapView with support for both convenience and explicit parameter APIs
Creates a complete Swift example showcasing interactive US state selection with feature-state expressions
Updates documentation with comprehensive guides and API references for the new functionality

Reviewed Changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
platform/ios/src/MLNMapView.mm	Implements core feature state methods with MBGL integration and state conversion
platform/ios/src/MLNMapView.h	Adds public API declarations and comprehensive documentation for feature state methods
platform/ios/app-swift/Sources/FeatureStateExample.swift	Complete interactive example demonstrating feature state usage with US states data
platform/ios/app-swift/Sources/MapLibreNavigationView.swift	Adds navigation link to the new feature state example
platform/ios/MapLibre.docc/FeatureStateExample.md	Comprehensive documentation with code examples and best practices
platform/ios/MapLibre.docc/MapLibre.md	Updates main documentation index to include feature state example
platform/ios/MapLibre.docc/ObserverExample.md	Minor code formatting improvement in observer example
platform/ios/MapLibre.docc/ActionJournalExample.md	Adds rendering stats report interval configuration

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-10-04T08:12:26Z

platform/ios/src/MLNMapView.mm

+        return;
+    }
+
+    NSString *featureID = [NSString stringWithFormat:@"%@", feature.identifier];


This line could crash if feature.identifier is nil. The stringWithFormat will convert nil to '(null)' string, which may not be the intended behavior for feature identification.

Copilot · 2025-10-04T08:12:26Z

platform/ios/src/MLNMapView.mm

+        return nil;
+    }
+
+    NSString *featureID = [NSString stringWithFormat:@"%@", feature.identifier];


This line could crash if feature.identifier is nil. The stringWithFormat will convert nil to '(null)' string, which may not be the intended behavior for feature identification.

Copilot · 2025-10-04T08:12:26Z

platform/ios/src/MLNMapView.mm

+        return;
+    }
+
+    NSString *featureID = [NSString stringWithFormat:@"%@", feature.identifier];


This line could crash if feature.identifier is nil. The stringWithFormat will convert nil to '(null)' string, which may not be the intended behavior for feature identification.

Copilot · 2025-10-04T08:12:27Z

platform/ios/MapLibre.docc/FeatureStateExample.md

+mapView.setFeatureState(feature, sourceID: "states", state: ["selected": true])
+
+// Set feature state using explicit identifiers
+mapView.setFeatureState("states", sourceLayer: nil, featureID: "54", state: ["selected": true])


This method call is incorrect. The first parameter should be sourceID, but the method name suggests it should be setFeatureStateForSource. The correct call should be mapView.setFeatureStateForSource(\"states\", sourceLayer: nil, featureID: \"54\", state: [\"selected\": true]).

Suggested change

mapView.setFeatureState("states", sourceLayer: nil, featureID: "54", state: ["selected": true])

mapView.setFeatureStateForSource("states", sourceLayer: nil, featureID: "54", state: ["selected": true])

Copilot · 2025-10-04T08:12:27Z

platform/ios/MapLibre.docc/FeatureStateExample.md

+let isSelected = currentState?["selected"] as? Bool ?? false
+
+// Get state using explicit identifiers
+let state = mapView.getFeatureState("states", sourceLayer: nil, featureID: "54")


This method call is incorrect. The method name should be getFeatureStateForSource. The correct call should be mapView.getFeatureStateForSource(\"states\", sourceLayer: nil, featureID: \"54\").

Suggested change

let state = mapView.getFeatureState("states", sourceLayer: nil, featureID: "54")

let state = mapView.getFeatureStateForSource("states", sourceLayer: nil, featureID: "54")

Copilot · 2025-10-04T08:12:27Z

platform/ios/MapLibre.docc/FeatureStateExample.md

+- ``MLNMapView/setFeatureState:sourceLayer:featureID:state:`` - Set state with explicit identifiers
+- ``MLNMapView/getFeatureState:sourceID:`` - Get current state of a feature
+- ``MLNMapView/getFeatureState:sourceLayer:featureID:`` - Get state with explicit identifiers
+- ``MLNMapView/removeFeatureState:sourceID:stateKey:`` - Remove state from a feature
+- ``MLNMapView/removeFeatureState:sourceLayer:featureID:stateKey:`` - Remove state with explicit identifiers


The documentation references are incorrect for the explicit identifier methods. Lines 216, 218, and 220 should reference setFeatureStateForSource:sourceLayer:featureID:state:, getFeatureStateForSource:sourceLayer:featureID:, and removeFeatureStateForSource:sourceLayer:featureID:stateKey: respectively.

Suggested change

- ``MLNMapView/setFeatureState:sourceLayer:featureID:state:`` - Set state with explicit identifiers

- ``MLNMapView/getFeatureState:sourceID:`` - Get current state of a feature

- ``MLNMapView/getFeatureState:sourceLayer:featureID:`` - Get state with explicit identifiers

- ``MLNMapView/removeFeatureState:sourceID:stateKey:`` - Remove state from a feature

- ``MLNMapView/removeFeatureState:sourceLayer:featureID:stateKey:`` - Remove state with explicit identifiers

- ``MLNMapView/setFeatureStateForSource:sourceLayer:featureID:state:`` - Set state with explicit identifiers

- ``MLNMapView/getFeatureState:sourceID:`` - Get current state of a feature

- ``MLNMapView/getFeatureStateForSource:sourceLayer:featureID:`` - Get state with explicit identifiers

- ``MLNMapView/removeFeatureState:sourceID:stateKey:`` - Remove state from a feature

- ``MLNMapView/removeFeatureStateForSource:sourceLayer:featureID:stateKey:`` - Remove state with explicit identifiers

Add feature state functionality to iOS

d18e982

github-actions bot added the iOS label Oct 4, 2025

louwers mentioned this pull request Oct 4, 2025

Feature parity for "feature-state" expression #1698

Open

remove nonsensical references to hover

6807f12

louwers requested a review from Copilot October 4, 2025 08:11

Copilot AI reviewed Oct 4, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Add feature state functionality to iOS #3858

Add feature state functionality to iOS #3858

Uh oh!

louwers commented Oct 4, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Oct 4, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Oct 4, 2025

Uh oh!

Copilot AI Oct 4, 2025

Uh oh!

Copilot AI Oct 4, 2025

Uh oh!

Copilot AI Oct 4, 2025

Uh oh!

Copilot AI Oct 4, 2025

Uh oh!

Copilot AI Oct 4, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

	mapView.setFeatureState("states", sourceLayer: nil, featureID: "54", state: ["selected": true])
	mapView.setFeatureStateForSource("states", sourceLayer: nil, featureID: "54", state: ["selected": true])

	let state = mapView.getFeatureState("states", sourceLayer: nil, featureID: "54")
	let state = mapView.getFeatureStateForSource("states", sourceLayer: nil, featureID: "54")

Uh oh!

Add feature state functionality to iOS #3858

Are you sure you want to change the base?

Add feature state functionality to iOS #3858

Uh oh!

Conversation

louwers commented Oct 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Oct 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Bloaty Results (iOS) 🐋

Full report: https://maplibre-native.s3.eu-central-1.amazonaws.com/bloaty-results-ios/pr-3858-compared-to-main.txt

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Oct 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 4, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

louwers commented Oct 4, 2025 •

edited

Loading

github-actions bot commented Oct 4, 2025 •

edited

Loading