Skip to content

[CI-4261] New Docs: Add Troubleshooting Section to Readme #220

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

Merged
merged 4 commits into from
May 8, 2025
Merged

[CI-4261] New Docs: Add Troubleshooting Section to Readme #220

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ff1ab0a
add troubleshooting section
Mudaafi May 7, 2025
d3ca70d
left align text in tables
Mudaafi May 7, 2025
cda0ef1
use html instead of markdown to render table
Mudaafi May 7, 2025
168ec27
Update discussions link
Mudaafi May 7, 2025
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
57 changes: 57 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,63 @@ Ready-to-use, copy-paste examples with explanations.

🔹 For more advanced use cases check the [full documentation](https://constructor-io.github.io/constructorio-ui-autocomplete/?path=/docs/autocomplete-component-advanced-parameters--docs)

## 🛠 Troubleshooting

Common issues and solutions.

<table>
<thead>
<tr>
<th>Problem</th>
<th>Description</th>
<th>Solution</th>
</tr>
</thead>
<tbody>
<tr>
<td>Older JavaScript environments</td>
<td>
The library provides two different builds. CommonJS (cjs) and ECMAScript Modules (mjs)
<br>
<br>
For ECMAScript Modules (mjs) build, the JavaScript version is ESNext which might not be supported by your environment. If that's the case and your environment is using an older Javascript version like ES6 (ES2015), you might get this error.
<br>
<br>
<code>Module parse failed: Unexpected token (15:32) You may need an appropriate loader to handle this file type, currently no loaders are configured to process this file</code>
</td>
<td>
To solve this you can import the CommonJS (cjs) build which supports ES6 (ES2015) syntax:
<br>
<br>
<code>import CioAutocomplete from '@constructor-io/constructorio-ui-autocomplete/cjs'</code>
</td>
</tr>
<tr>
<td>ESLint</td>
<td>
There is a known issue with ESLint where it fails to resolve the paths exposed in the exports statement of NPM packages.
<br>
<br>
For ECMAScript Modules (mjs) build. The Javascript version is ESNext which might not be supported by your environment. If that's the case and your environment is using an older Javascript version like ES6 (ES2015), you might get this error.
<br>
<br>
<code>Unable to resolve path to module '@constructor-io/constructorio-ui-autocomplete/styles.css'</code>
<br>
<br>
Relevant open issues:
<ul>
<li><a href='https://github.com/import-js/eslint-plugin-import/issues/1868'>Issue 1868</a>
<li><a href='https://github.com/import-js/eslint-plugin-import/issues/1810'>Issue 1810</a>
</td>
<td>
If you are receiving the following error, you can safely disable ESLint using <code>// eslint-disable-line</code> for that line.
</td>
</tr>
</tbody>
</table>

💬 Need help? Join our [GitHub Discussions](https://github.com/Constructor-io/constructorio-ui-autocomplete/discussions)

## 📖 API Reference

<!-- TODO: reference the API docs from storybook -->
Expand Down
Loading