Skip to content

Latest commit

 

History

History
167 lines (138 loc) · 5.24 KB

HELP.adoc

File metadata and controls

167 lines (138 loc) · 5.24 KB

A User’s Guide to Getting Help

Table of Contents

Decision table

Please read all the entries bellow before choosing the one that best fits your case, and proceed with the recommendations.

Issue

I am encountering a failure.

The library is not honoring an area of the CSS/HTML standard.

The library is not behaving as it claims or should.

I want to do X with this library, is it possible?

I am having trouble to understand how to use a specific feature of this library.

I am encountering a failure.

I am using react-native-render-html and I am witnessing a failure such as:

  • A Red screen of death during development that is caused by an object of this library;

  • A failure while building the app for production;

  • A crash or exception when rendering a component of this library.

Recommendations

  1. Read the Common Issues section bellow.

  2. Take a look at stackoverflow.com/questions/tagged/react-native-render-html for similar questions.

  3. Take a look at our issue tracker for similar questions.

  4. If you still don’t have a solution, you can choose one or more:

    1. Submitting a Bug Report.

    2. Going to our Discord #support channel.

The library is not honoring an area of the CSS/HTML standard.

For example, it doesn’t render tag YYY or replicate the behavior of attribute XXX. This library is not meant for an exact compliance with the standard. First and foremost, because React Native imposes some constrains that we cannot overcome, and secondly, because the philosophy of the library is to let you customize rendering to fit your needs rather than strictly honoring the standards. Finally, because the react-native-webview library fits this purpose.

However, we are always open to feature requests and propositions for enhancement regarding better compliance with the standards. You’re more than welcomed to open a ticket and discuss the feature on our #general Discord channel.

The library is not behaving as it claims or should.

For example:

  1. The documentation says something, but the behavior differs.

  2. The library should obviously have the behavior I’m expecting, but it doesn’t.

Recommendations

  1. Make sure your issue isn’t covered by the docs.

  2. Read the Common Issues section bellow.

  3. Take a look at stackoverflow.com/questions/tagged/react-native-render-html for similar questions.

  4. Take a look at our issue tracker for similar questions.

  5. If you still don’t have a solution, you can choose one or more:

    1. Submitting a Bug Report.

    2. Going to our Discord #support channel. Please note that if your issue is not trivial, we will probably ask you to fill a bug report anyway.

I want to do X with this library, is it possible?

Recommendations

  1. Make sure the feature isn’t covered by the docs.

  2. Read the Common Issues section bellow.

  3. Take a look at stackoverflow.com/questions/tagged/react-native-render-html for similar questions.

  4. Take a look at our issue tracker for similar questions.

  5. If you still don’t have an answer, you can choose one or more:

    1. Opening a StackOverflow post with the react-native-render-html tag.

    2. Submitting a Feature Request.

    3. Going to our Discord #support channel.

I am having trouble to understand how to use a specific feature of this library.

Recommendations

  1. Carefully read the docs.

  2. Read the Common Issues section bellow.

  3. If you still find difficult to use this feature, then we are lacking good documentation and we should fix it. Go to our Discord #support channel and we will help you out.

Common Issues

Issue Solution

Unable to resolve XXX from node_modules/YYY

stackoverflow.com/a/63111913/2779871

The application crashes while using react-native-screens

stackoverflow.com/q/63171131/2779871

How to render iframes?

github.com/native-html/plugins/tree/master/packages/iframe-plugin#readme

How to render tables?

github.com/native-html/plugins/tree/master/packages/table-plugin#readme

How to open the browser when a link is pressed?

stackoverflow.com/q/63114501/2779871

How to access the raw HTML from a custom renderer?

stackoverflow.com/q/63979897/2779871

How to set images max width when img element already has a width attribute?

stackoverflow.com/a/64077140/2779871