Documentation CircuitContext tags?

[eboudrant]

I don't see an example where a tag is set, I don't see reference to it in the documentation but the tags api is exposed in the factory, ex:

    override fun create(
        screen: Screen,
        navigator: Navigator,
        context: CircuitContext,
    ): Presenter<*>? {
      val component = context.tag<MyComponentClass>()

I wonder if we can use tags api for passing components to the presenter. I'mo not sure when/where I can call the putTags (since LocalCircuitContext is internal).

[ZacSweers]

Thanks for calling that out. LocalCircuitContext is indeed not a public API. Tags are for breadcrumbing metadata of your own types through Circuit's plumbing. You can access these from factories to pass shared resources (such as telemetry) and read them in other factories or EventListener. We documented it a bit in the release notes, will try to get some better formal docs up after the holidays.