search

andyduke / styled_text_package

Text widget with formatted text using tags. Makes it easier to use formatted text in multilingual applications.
https://pub.dev/packages/styled_text
BSD 3-Clause "New" or "Revised" License
75 stars 48 forks source link

Better documentation #23

Closed andreyevyk closed 3 years ago

andreyevyk commented 3 years ago

Many things what i want to use in the project, like a break line, don't are in documentation.

andyduke commented 3 years ago

Many things what i want to use in the project, like a break line, don't are in documentation.

What exactly is missing from the documentation?

Zabadam commented 3 years ago

Here are the escape characters you may use.

New lines may be produced simply by '\n' within the text param, considering the newLinesAsBreaks property.

Unverified, because I haven't tried, but a self-terminating break <br/> oughta do the trick as well.

apalala-dev commented 3 years ago

This package is great but I believe these things (how to insert new lines, escaping charaters) should be in the Readme file. In french for instance, the apostrophe is pretty common and is not printed if nothing is done. A simple .replaceAll("\'", "&apos;") fixes it.

andyduke commented 3 years ago

This package is great but I believe these things (how to insert new lines, escaping charaters) should be in the Readme file. In french for instance, the apostrophe is pretty common and is not printed if nothing is done. A simple .replaceAll("\'", "&apos;") fixes it.

I have updated the Readme in version 2.0.0 with null-safety.