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

Jump to bottom

docs: expand & clarify FAQ entry on using client-only libraries #10886

Merged
merged 5 commits into from
Oct 25, 2023
Merged

docs: expand & clarify FAQ entry on using client-only libraries #10886

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
fc068c9
docs: fix random lint warnings in FAQ
HoldYourWaffle Oct 17, 2023
a2ddf19
docs: clarify FAQ on client-only libraries
HoldYourWaffle Oct 17, 2023
f1cdd96
docs: add note about race conditions with async onMount to FAQ on cli…
HoldYourWaffle Oct 17, 2023
499e701
docs: add example of client-only async component
HoldYourWaffle Oct 17, 2023
6cf7255
condense
benmccann Oct 25, 2023
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
37 changes: 20 additions & 17 deletions documentation/docs/60-appendix/01-faq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,21 +141,24 @@ onMount(() => {
});
```

Otherwise, if the library has side effects and you'd still prefer to use static imports, check out [vite-plugin-iso-import](https://github.com/bluwy/vite-plugin-iso-import) to support the `?client` import suffix. The import will be stripped out in SSR builds. However, note that you will lose the ability to use VS Code Intellisense if you use this method.

```js
// @filename: ambient.d.ts
// @lib: ES2015
declare module 'some-browser-only-library?client';

// @filename: index.js
// ---cut---
import { onMount } from 'svelte';
import { method } from 'some-browser-only-library?client';

onMount(() => {
method('hello world');
});
Finally, you may also consider using an `{#await}` block:
```svelte
<!--- file: index.svelte --->
<script>
import { browser } from '$app/environment';

const ComponentConstructor = browser ?
import('some-browser-only-library').then((module) => module.Component) :
new Promise(() => {});
</script>

{#await ComponentConstructor}
<p>Loading...</p>
{:then component}
<svelte:component this={component} />
{:catch error}
<p>Something went wrong: {error.message}</p>
{/await}
```

### How do I use a different backend API server?
Expand Down Expand Up @@ -234,11 +237,11 @@ yarn set version berry
yarn install
```

**Yarn 3 global cache**
#### Yarn 3 global cache

One of the more interesting features of Yarn Berry is the ability to have a single global cache for packages, instead of having multiple copies for each project on the disk. However, setting `enableGlobalCache` to true causes building to fail, so it is recommended to add the following to the `.yarnrc.yml` file:

```
```yaml
nodeLinker: node-modules
```

Expand Down
Loading