Feature request: hoist observable state

[ZacSweers]

About this issue

Currently, Markdown composables are fairly black-box. While this convenient, I'd like to suggest a feature request to extract a MarkdownState class that exposes observable State properties for parsed markdown components.

My example use case for this is being able to get a list of URLs.

interface MarkdownState {
  val parsedUrls: List<String>

  // Allow eager parsing, unlocking pre-computing and possibly multithreading
  suspend fun parse()
}

val state = rememberMarkdownState(text)
Markdown(state) // Alternative overload to Markdown(String)

if (state.parsedUrls.isNotEmpty()) {
  LaunchedEffect(Unit) {
    preWarmUrls(state.parsedUrls)
  }
}

Checklist

• Searched for similar issues
• Checked out the sample application
• Read the README
• Checked out the CHANGELOG
• Read the FAQ
• Checked out the MIGRATION GUIDE

[mikepenz]

I really think that's an amazing proposal. Thank you! I might not have the bandwidth this week to look into it. In case you had more bandwidth happy to take a PR.

[ZacSweers]

Let me see if I can take a crack at it 👍

[mikepenz]

While this PR does not yet introduce state like proposed, it's one step closer to this goal.

It will now allow you to pass over your own ReferenceLinkHandler implementation, so you can customize the behavior for found links more easily.

It will now also preloadLinks from the parsed markdown prior rendering (can be disabled) - this was done to add support for reference links.

---

Still working on refining that API to actually provide hopefully a solution to what you have suggested.

[mikepenz]

Ok, a new observable state API has been introduced here: #348

[mikepenz]

Additional notes in the beta release notes: https://github.com/mikepenz/multiplatform-markdown-renderer/releases/tag/v0.33.0-b02