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

feat: update extended client:visible to use an object instead of a string #9596

Merged
merged 6 commits into from
Jan 4, 2024
Merged

feat: update extended client:visible to use an object instead of a string #9596

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e828cd0
Revert "feat: support setting rootMargin for `client:visible` (#9363)"
Princesseuh Jan 3, 2024
8fa9c8c
feat: update extended `client:visible` to use an object instead of a …
Princesseuh Jan 3, 2024
e2db526
Apply suggestions from code review
Princesseuh Jan 3, 2024
f244bba
test: add a test
Princesseuh Jan 3, 2024
7723c01
nit: comment
Princesseuh Jan 3, 2024
8cbb65d
test: write the test some other way to try to convince playwright
Princesseuh Jan 3, 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
10 changes: 0 additions & 10 deletions .changeset/stupid-peas-juggle.md
View file
Open in desktop

This file was deleted.

10 changes: 10 additions & 0 deletions .changeset/three-owls-drop.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
"astro": minor
---

Adds the ability to set a [`rootMargin`](https://developer.mozilla.org/en-US/docs/Web/API/IntersectionObserver/rootMargin) setting when using the `client:visible` directive. This allows a component to be hydrated when it is _near_ the viewport, rather than hydrated when it has _entered_ the viewport.

```astro
<!-- Load component when it's within 200px away from entering the viewport -->
<Component client:visible={{ rootMargin: "200px" }} />
```
11 changes: 10 additions & 1 deletion packages/astro/e2e/custom-client-directives.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { expect } from '@playwright/test';
import { testFactory, waitForHydrate } from './test-utils.js';
import testAdapter from '../test/test-adapter.js';
import { testFactory, waitForHydrate } from './test-utils.js';

const test = testFactory({
root: './fixtures/custom-client-directives/',
Expand Down Expand Up @@ -89,4 +89,13 @@ function testClientDirectivesShared() {
// Hydrated, this should be 1
await expect(counterValue).toHaveText('1');
});

test('Client directives should be passed options correctly', async ({ astro, page }) => {
Princesseuh marked this conversation as resolved.
Show resolved Hide resolved
await page.goto(astro.resolveUrl('/'));

const clientOptions = page.locator('#options');
await expect(clientOptions).toHaveText(
'Passed options are: {"message":"Hello! I was passed as an option"}'
);
});
}
18 changes: 16 additions & 2 deletions packages/astro/e2e/fixtures/custom-client-directives/astro.config.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import { defineConfig } from 'astro/config';
import react from "@astrojs/react";
import { defineConfig } from 'astro/config';
import { fileURLToPath } from 'node:url';

export default defineConfig({
integrations: [astroClientClickDirective(), astroClientPasswordDirective(), react()],
integrations: [astroClientClickDirective(), astroClientPasswordDirective(), astroHasOptionsDirective(), react()],
});

function astroClientClickDirective() {
Expand Down Expand Up @@ -33,3 +33,17 @@ function astroClientPasswordDirective() {
}
};
}

function astroHasOptionsDirective() {
return {
name: 'astro-options',
hooks: {
'astro:config:setup': (opts) => {
opts.addClientDirective({
name: 'options',
entrypoint: fileURLToPath(new URL('./client-options.js', import.meta.url))
});
}
}
};
}
6 changes: 6 additions & 0 deletions packages/astro/e2e/fixtures/custom-client-directives/client-options.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
// Hydrate directly and write the passed options to the DOM
export default async (load, options) => {
const hydrate = await load()
document.write(`<div id="options">Passed options are: ${JSON.stringify(options.value)}</div>`)
natemoo-re marked this conversation as resolved.
Show resolved Hide resolved
await hydrate()
}
5 changes: 3 additions & 2 deletions packages/astro/e2e/fixtures/custom-client-directives/src/client-directives-types.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
declare module 'astro' {
interface AstroClientDirectives {
'client:click'?: boolean
'client:password'?: string
'client:password'?: string
'client:options'?: { message: string }
}
}

// Make d.ts a module to similate common packaging setups where the entry `index.d.ts` would augment the types
export {}
export { }
3 changes: 2 additions & 1 deletion packages/astro/e2e/fixtures/custom-client-directives/src/pages/index.astro
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,6 @@ import Counter from '../components/Counter.jsx';
<body>
<Counter id="client-click" client:click>client:click</Counter>
<Counter id="client-password" client:password="hunter2">client:password</Counter>
<Counter id="client-has-options" client:options={{message: "Hello! I was passed as an option"}}>client:options</Counter>
</body>
</html>
</html>
8 changes: 5 additions & 3 deletions packages/astro/src/@types/astro.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,19 +65,21 @@ export type {
export type { RemotePattern } from '../assets/utils/remotePattern.js';
export type { SSRManifest } from '../core/app/types.js';
export type {
AstroCookies,
AstroCookieSetOptions,
AstroCookieGetOptions,
AstroCookieSetOptions,
AstroCookies,
} from '../core/cookies/index.js';

export interface AstroBuiltinProps {
'client:load'?: boolean;
'client:idle'?: boolean;
'client:media'?: string;
'client:visible'?: string | boolean;
'client:visible'?: ClientVisibleOptions | boolean;
'client:only'?: boolean | string;
}

export type ClientVisibleOptions = Pick<IntersectionObserverInit, 'rootMargin'>;

export interface TransitionAnimation {
name: string; // The name of the keyframe
delay?: number | string;
Expand Down
9 changes: 6 additions & 3 deletions packages/astro/src/runtime/client/visible.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type { ClientDirective } from '../../@types/astro.js';
import type { ClientDirective, ClientVisibleOptions } from '../../@types/astro.js';

/**
* Hydrate this component when one of it's children becomes visible
Expand All @@ -11,8 +11,11 @@ const visibleDirective: ClientDirective = (load, options, el) => {
await hydrate();
};

const ioOptions = {
rootMargin: typeof options.value === 'string' ? options.value : undefined,
const rawOptions =
typeof options.value === 'object' ? (options.value as ClientVisibleOptions) : undefined;

Princesseuh marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Final nit: this technically adds support for all IntersectionObserverInit values, but our types are narrowed to only support Pick<IntersectionObserverInit, 'rootMargin'>. Is that desired?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It doesn't, see the code below

const ioOptions: IntersectionObserverInit = {
rootMargin: rawOptions?.rootMargin,
};

const io = new IntersectionObserver((entries) => {
Expand Down
Loading