astro-docs-template

astro-docs-template copied to clipboard

v3.5.4

Compare Source

Patch Changes

• #​12481 8a46e80 Thanks @​marbrex! - Resolve vite peer dependency problem for strict package managers like Yarn in PnP mode.

v3.5.3

Compare Source

Patch Changes

• #​11930 4a44e82 Thanks @​lukasbachlechner! - Preact components no longer throw an error if a property is null.

v3.5.2

Compare Source

Patch Changes

• #​11834 5f2536b Thanks @​ph1p! - Preact signals are now serialized correctly in arrays when they are given to components.

v3.5.1

Compare Source

Patch Changes

• #​11464 2cdb685 Thanks @​rschristian! - Swap out preact-ssr-prepass for renderToStringAsync from preact-render-to-string

v3.5.0

Compare Source

Minor Changes

• #​11234 4385bf7 Thanks @​ematipico! - Adds a new function called addServerRenderer to the Container API. Use this function to manually store renderers inside the instance of your container.

  This new function should be preferred when using the Container API in environments like on-demand pages:

  import type { APIRoute } from 'astro';
  import { experimental_AstroContainer } from 'astro/container';
  import reactRenderer from '@​astrojs/react/server.js';
  import vueRenderer from '@​astrojs/vue/server.js';
  import ReactComponent from '../components/button.jsx';
  import VueComponent from '../components/button.vue';
  
  // MDX runtime is contained inside the Astro core
  import mdxRenderer from 'astro/jsx/server.js';
  
  // In case you need to import a custom renderer
  import customRenderer from '../renderers/customRenderer.js';
  
  export const GET: APIRoute = async (ctx) => {
    const container = await experimental_AstroContainer.create();
    container.addServerRenderer({ renderer: reactRenderer });
    container.addServerRenderer({ renderer: vueRenderer });
    container.addServerRenderer({ renderer: customRenderer });
    // You can pass a custom name too
    container.addServerRenderer({
      name: 'customRenderer',
      renderer: customRenderer,
    });
    const vueComponent = await container.renderToString(VueComponent);
    return await container.renderToResponse(Component);
  };
  

v3.4.0

Compare Source

Minor Changes

• #​11144 803dd80 Thanks @​ematipico! - The integration now exposes a function called getContainerRenderer, that can be used inside the Container APIs to load the relative renderer.

  import { experimental_AstroContainer as AstroContainer } from 'astro/container';
  import ReactWrapper from '../src/components/ReactWrapper.astro';
  import { loadRenderers } from 'astro:container';
  import { getContainerRenderer } from '@​astrojs/react';
  
  test('ReactWrapper with react renderer', async () => {
    const renderers = await loadRenderers([getContainerRenderer()]);
    const container = await AstroContainer.create({
      renderers,
    });
    const result = await container.renderToString(ReactWrapper);
  
    expect(result).toContain('Counter');
    expect(result).toContain('Count: <!-- -->5');
  });
  

v3.3.0

Compare Source

Minor Changes

• #​10938 fd508a0 Thanks @​florian-lefebvre! - Adds a devtools option

  You can enable Preact devtools in development by setting devtools: true in your preact() integration config:

  import { defineConfig } from 'astro/config';
  import preact from '@​astrojs/preact';
  
  export default defineConfig({
    integrations: [preact({ devtools: true })],
  });
  

v3.2.0

Compare Source

Minor Changes

• #​10689 683d51a5eecafbbfbfed3910a3f1fbf0b3531b99 Thanks @​ematipico! - Deprecate support for versions of Node.js older than v18.17.1 for Node.js 18, older than v20.0.3 for Node.js 20, and the complete Node.js v19 release line.

  This change is in line with Astro's Node.js support policy.

v3.1.2

Compare Source

Patch Changes

• #​10585 ad50784adc6f262fc563999e97df3a5dc9087c88 Thanks @​rschristian! - Fixes (theoretical) edge case in Preact integration's JSX aliases

v3.1.1

Compare Source

Patch Changes

• #​10200 c692d0c66a5062937e47402dc700d41c2a5dfc5c Thanks @​Princesseuh! - Fixes passing children to server-rendered components causing an error

v3.1.0

Compare Source

Minor Changes

• #​9524 0903ef90494e9c8bd0272347a0cdd51eca7f4648 Thanks @​aleksandrjet! - Allows rendering lazy components.

  You can now use lazy components with Suspense:

  import { lazy, Suspense } from 'preact/compat';
  
  const HeavyComponent = lazy(() => import('./HeavyComponent'));
  
  const Component = () => {
    return (
      <Suspense fallback={<p>Loading...</p>}>
        <HeavyComponent foo="bar" />
      </Suspense>
    );
  };
  

v3.0.2

Compare Source

Patch Changes

• #​9482 72b26daf694b213918f02d0fcbf90ab5b7ebc31f Thanks @​natemoo-re! - Improves compatibility with the Qwik adapter

• #​9479 1baf0b0d3cbd0564954c2366a7278794fad6726e Thanks @​sarah11918! - Updates README

v3.6.3

Compare Source

Patch Changes

• #​12481 8a46e80 Thanks @​marbrex! - Resolve vite peer dependency problem for strict package managers like Yarn in PnP mode.

v3.6.2

Compare Source

Patch Changes

• #​11624 7adb350 Thanks @​bluwy! - Prevents throwing errors when checking if a component is a React component in runtime

v3.6.1

Compare Source

Patch Changes

• #​11571 1c3265a Thanks @​bholmesdev! - BREAKING CHANGE to the experimental Actions API only. Install the latest @astrojs/react integration as well if you're using React 19 features.

  Make .safe() the default return value for actions. This means { data, error } will be returned when calling an action directly. If you prefer to get the data while allowing errors to throw, chain the .orThrow() modifier.

  import { actions } from 'astro:actions';
  
  // Before
  const { data, error } = await actions.like.safe();
  // After
  const { data, error } = await actions.like();
  
  // Before
  const newLikes = await actions.like();
  // After
  const newLikes = await actions.like.orThrow();
  

v3.6.0

Compare Source

Minor Changes

• #​11234 4385bf7 Thanks @​ematipico! - Adds a new function called addServerRenderer to the Container API. Use this function to manually store renderers inside the instance of your container.

  This new function should be preferred when using the Container API in environments like on-demand pages:

  import type { APIRoute } from 'astro';
  import { experimental_AstroContainer } from 'astro/container';
  import reactRenderer from '@​astrojs/react/server.js';
  import vueRenderer from '@​astrojs/vue/server.js';
  import ReactComponent from '../components/button.jsx';
  import VueComponent from '../components/button.vue';
  
  // MDX runtime is contained inside the Astro core
  import mdxRenderer from 'astro/jsx/server.js';
  
  // In case you need to import a custom renderer
  import customRenderer from '../renderers/customRenderer.js';
  
  export const GET: APIRoute = async (ctx) => {
    const container = await experimental_AstroContainer.create();
    container.addServerRenderer({ renderer: reactRenderer });
    container.addServerRenderer({ renderer: vueRenderer });
    container.addServerRenderer({ renderer: customRenderer });
    // You can pass a custom name too
    container.addServerRenderer({
      name: 'customRenderer',
      renderer: customRenderer,
    });
    const vueComponent = await container.renderToString(VueComponent);
    return await container.renderToResponse(Component);
  };
  

v3.5.0

Compare Source

Minor Changes

• #​11144 803dd80 Thanks @​ematipico! - The integration now exposes a function called getContainerRenderer, that can be used inside the Container APIs to load the relative renderer.

  import { experimental_AstroContainer as AstroContainer } from 'astro/container';
  import ReactWrapper from '../src/components/ReactWrapper.astro';
  import { loadRenderers } from 'astro:container';
  import { getContainerRenderer } from '@​astrojs/react';
  
  test('ReactWrapper with react renderer', async () => {
    const renderers = await loadRenderers([getContainerRenderer()]);
    const container = await AstroContainer.create({
      renderers,
    });
    const result = await container.renderToString(ReactWrapper);
  
    expect(result).toContain('Counter');
    expect(result).toContain('Count: <!-- -->5');
  });
  

v3.4.0

Compare Source

Minor Changes

• #​11071 8ca7c73 Thanks @​bholmesdev! - Adds two new functions experimental_getActionState() and experimental_withState() to support the React 19 useActionState() hook when using Astro Actions. This introduces progressive enhancement when calling an Action with the withState() utility.

  This example calls a like action that accepts a postId and returns the number of likes. Pass this action to the experimental_withState() function to apply progressive enhancement info, and apply to useActionState() to track the result:

  import { actions } from 'astro:actions';
  import { experimental_withState } from '@​astrojs/react/actions';
  
  export function Like({ postId }: { postId: string }) {
    const [state, action, pending] = useActionState(
      experimental_withState(actions.like),
      0, // initial likes
    );
  
    return (
      <form action={action}>
        <input type="hidden" name="postId" value={postId} />
        <button disabled={pending}>{state} ❤️</button>
      </form>
    );
  }
  

  You can also access the state stored by useActionState() from your action handler. Call experimental_getActionState() with the API context, and optionally apply a type to the result:

  import { defineAction, z } from 'astro:actions';
  import { experimental_getActionState } from '@​astrojs/react/actions';
  
  export const server = {
    like: defineAction({
      input: z.object({
        postId: z.string(),
      }),
      handler: async ({ postId }, ctx) => {
        const currentLikes = experimental_getActionState<number>(ctx);
        // write to database
        return currentLikes + 1;
      },
    }),
  };
  

v3.3.4

Compare Source

Patch Changes

• #​10986 4d16381 Thanks @​emish89! - Fixes incorrect peerDependencies for @types/react and @types/react-dom

v3.3.3

Compare Source

Patch Changes

• #​10942 d47baa4 Thanks @​matthewp! - Updates package to support React 19 beta

v3.3.2

Compare Source

Patch Changes

• #​10893 fd7a9ed Thanks @​Angrigo! - Removes using deprecated ReactDOMServer.renderToStaticNodeStream API

v3.3.1

Compare Source

Patch Changes

• #​10855 f6bddd3 Thanks @​lamATnginx! - Fix Redoc usage in React integration

v3.3.0

Compare Source

Minor Changes

• #​10689 683d51a5eecafbbfbfed3910a3f1fbf0b3531b99 Thanks @​ematipico! - Deprecate support for versions of Node.js older than v18.17.1 for Node.js 18, older than v20.0.3 for Node.js 20, and the complete Node.js v19 release line.

  This change is in line with Astro's Node.js support policy.

v3.2.0

Compare Source

Minor Changes

• #​10675 14f1d49a10541fecc4c10def8a094322442ccf23 Thanks @​fightingcat! - Expose Babel config for @​astro/react.

v3.1.1

Compare Source

Patch Changes

• #​10654 195f51f82a44df32be73865949aabee0d46ffe61 Thanks @​matthewp! - Mark @​material-tailwind/react as noExternal

v3.1.0

Compare Source

Minor Changes

• #​10136 9cd84bd19b92fb43ae48809f575ee12ebd43ea8f Thanks @​matthewp! - Changes the default behavior of transition:persist to update the props of persisted islands upon navigation. Also adds a new view transitions option transition:persist-props (default: false) to prevent props from updating as needed.

  Islands which have the transition:persist property to keep their state when using the <ViewTransitions /> router will now have their props updated upon navigation. This is useful in cases where the component relies on page-specific props, such as the current page title, which should update upon navigation.

  For example, the component below is set to persist across navigation. This component receives a products props and might have some internal state, such as which filters are applied:

  <ProductListing transition:persist products={products} />
  

  Upon navigation, this component persists, but the desired products might change, for example if you are visiting a category of products, or you are performing a search.

  Previously the props would not change on navigation, and your island would have to handle updating them externally, such as with API calls.

  With this change the props are now updated, while still preserving state.

  You can override this new default behavior on a per-component basis using transition:persist-props=true to persist both props and state during navigation:

  <ProductListing transition:persist-props="true" products={products} />
  

v3.0.10

Compare Source

Patch Changes

• #​9849 20ca3154fb37049cbcd51b06d9fa2ef25ac25a36 Thanks @​StandardGage! - Fixes an issue where passing void elements (img, etc..) did not work with the experimentalReactChildren option enabled

v3.0.9

Compare Source

Patch Changes

• #​9482 72b26daf694b213918f02d0fcbf90ab5b7ebc31f Thanks @​natemoo-re! - Improves compatibility with the Qwik adapter

• #​9479 1baf0b0d3cbd0564954c2366a7278794fad6726e Thanks @​sarah11918! - Updates README

v3.0.8

Compare Source

Patch Changes

• #​9403 7eb9fe8a7 Thanks @​knpwrs! - Prevents unsupported forwardRef components created by Preact from being rendered by React

• #​9452 e83b5095f Thanks @​florian-lefebvre! - Upgrades vite to latest

v3.0.7

Compare Source

Patch Changes

• #​9122 1c48ed286 Thanks @​bluwy! - Adds Vite 5 support. There are no breaking changes from Astro. Check the Vite migration guide for details of the breaking changes from Vite instead.

v3.0.6

Compare Source

Patch Changes

• #​9141 af43fb517 Thanks @​lilnasy! - Fixes an issue where slotting self-closing elements (img, br, hr) into react components with experimentalReactChildren enabled led to an error.

v3.4.0

Compare Source

Minor Changes

• #​13753 90293de Thanks @​mattyoho! - Customize the filenames of sitemap XML files generated by the @astro/sitemap integration by setting filenameBase in the integration configuration settings. This may be useful when deploying an Astro site at a path on a domain with preexisting sitemap files.

  Generated sitemap files will appear at /sitemap-0.xml and /sitemap-index.xml by default, which may conflict with preexisting files. Set filenameBase to a custom value to avoid that if so:

  import { defineConfig } from 'astro/config';
  import sitemap from '@​astrojs/sitemap';
  
  export default defineConfig({
    site: 'https://example.com',
    integrations: [
      sitemap({
        filenameBase: 'astronomy-sitemap',
      }),
    ],
  });
  

  This will yield sitemap and index files as https://example.com/astronomy-sitemap-0.xml and https://example.com/astronomy-sitemap-index.xml.

v3.3.1

Patch Changes

• #​13591 5dd2d3f Thanks @​florian-lefebvre! - Removes unused code

v3.3.0

Minor Changes

• #​13448 91c9503 Thanks @​ematipico! - Add support for XSL in sitemap-index.xml

v3.2.1

Compare Source

Patch Changes

• #​12156 07754f5 Thanks @​mingjunlu! - Adds missing xslURL property to SitemapOptions type.

v3.2.0

Compare Source

Minor Changes

• #​11485 fbe1bc5 Thanks @​sondr3! - Adds new xslURL option to enable styling of sitemaps

v3.1.6

Compare Source

Patch Changes

• #​11263 7d59750 Thanks @​wackbyte! - Refactor to use Astro's integration logger for logging

v3.1.5

Compare Source

Patch Changes

• #​10779 cefeadf Thanks @​adrianlyjak! - Fixes false positives for status code routes like 404 and 500 when generating sitemaps.

v3.1.4

Compare Source

Patch Changes

• #​10772 0e22462d1534afc8f7bb6782f86db680c7a5f245 Thanks @​gislerro! - Fixes an issue where the root url does not follow the trailingSlash config option

v3.1.3

Compare Source

Patch Changes

• #​10795 1ce22881c657becf0397b83ac393fb5d2399104c Thanks @​bluwy! - Improves performance when generating the sitemap data

v3.1.2

Compare Source

Patch Changes

• #​10557 5f7e9c47e01116f6ec74b33770f480404680956a Thanks @​mingjunlu! - Fixes an issue where the base path is missing in sitemap-index.xml.

v3.1.1

Compare Source

Patch Changes

• #​10179 6343f6a438d790fa16a0dd268f4a51def4fa0f33 Thanks @​ematipico! - Revert https://github.com/withastro/astro/pull/9846

  The feature to customize the file name of the sitemap was reverted due to some internal issues with one of the dependencies. With an non-deterministic behaviour, the sitemap file was sometime emitted with incorrect syntax.

• #​9975 ec7d2ebbd96b8c2dfdadaf076bbf7953007536ed Thanks @​moose96! - Fixes URL generation for routes that rest parameters and start with /

v3.1.0

Compare Source

Minor Changes

• #​9846 9b78c992750cdb99c40a89a00ea2a0d1c00877d7 Thanks @​ktym4a! - Adds a new configuration option prefix that allows you to change the default sitemap-*.xml file name.

  By default, running astro build creates both sitemap-index.xml and sitemap-0.xml in your output directory.

  To change the names of these files (e.g. to astrosite-index.xml and astrosite-0.xml), set the prefix option in your sitemap integration configuration:

  import { defineConfig } from 'astro/config';
  import sitemap from '@​astrojs/sitemap';
  export default defineConfig({
    site: 'https://example.com',
    integrations: [
      sitemap({
        prefix: 'astrosite-',
      }),
    ],
  });
  

  This option is useful when Google Search Console is unable to fetch your default sitemap files, but can read renamed files.

v3.0.5

Compare Source

Patch Changes

• #​9704 b325fada567892b63ecae87c1ff845c8514457ba Thanks @​andremralves! - Fixes generated URLs when using a base with a SSR adapter

v3.0.4

Compare Source

Patch Changes

• #​9479 1baf0b0d3cbd0564954c2366a7278794fad6726e Thanks @​sarah11918! - Updates README