docs: document useSchematicCreditBalance for React, Vue, and Angular#362
Merged
Merged
Conversation
Add a "Credit balances" section to the React, Vue, and Angular SDK pages covering the new useSchematicCreditBalance hook/composable and the Angular creditBalance$ observable. Documents the settled default, the remaining/reserved opts.type escape hatch, the returned balance/isLoading shape, and where to find a feature's creditId. Mirrors the SDK READMEs from schematic-js PRs #1389 (React) and #1397 (Vue/Angular). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documents the new
useSchematicCreditBalancehook/composable (and the AngularcreditBalance$observable) added in schematic-js #1389 (React) and #1397 (Vue/Angular).Changes
Adds a Credit balances section to each SDK page, placed right after the existing plan/entitlement sections and matching the surrounding style:
react.mdx) —useSchematicCreditBalance("credit-id")returning{ balance, isLoading }.vue.mdx) — theuseSchematicCreditBalancecomposable returning reactiveComputedRefvalues.angular.mdx) — thecreditBalance$(creditId, type?)observable, plus a row in theSchematicServiceAPI reference table.Each section covers:
settled(spendable) default, the number to show end users.remaining/reservedescape hatch for advanced lease-aware accounting.balance/isLoadingshape.creditId(on the entitlement).Closes SCH-6590 (docs portion).
🤖 Generated with Claude Code