Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update ReadMe with details of FormattedDeferredText #99

Merged
merged 2 commits into from
Feb 28, 2024
Merged

Update ReadMe with details of FormattedDeferredText #99

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6f76ded
update readme with details of FormattedDeferredText
donaldchickeme Feb 19, 2024
e324266
adjust FormattedDeferredText description
donaldchickeme Feb 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,19 @@ val deferredFormattedString: DeferredFormattedString = deferredFormattedPlurals.
// If you have only the format args:
val deferredPlurals: DeferredPlurals = deferredFormattedPlurals.withFormatArgs("million")
```
#### Auxiliary type(s)
`FormattedDeferredText` is a type that wraps a `DeferredFormattedString` and it's relevant
arguments. This is useful when the format arguments are determined at the declaration site rather
than the resolution site.

```kotlin
val formattedString = DeferredFormattedString.Constant("%s and %s")
// Formatted text with arguments at resolution site
formattedString.resolve(context, "A", "B")

// Formatted text with arguments at declaration site
FormattedDeferredText(formattedString, "A", "B").resolve(context)
donaldchickeme marked this conversation as resolved.
Show resolved Hide resolved
```

All text-related types can eventually be converted to `DeferredText` through similar extensions.

Expand Down
Loading