{"id":15379937,"url":"https://github.com/marvinhagemeister/preact-server-renderer","last_synced_at":"2025-10-16T13:23:09.296Z","repository":{"id":57329602,"uuid":"93789092","full_name":"marvinhagemeister/preact-server-renderer","owner":"marvinhagemeister","description":"Server side rendering of preact components","archived":false,"fork":false,"pushed_at":"2018-08-01T20:16:42.000Z","size":120,"stargazers_count":63,"open_issues_count":3,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-28T23:43:33.451Z","etag":null,"topics":["nodejs","preact","ssr"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/marvinhagemeister.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-06-08T20:28:09.000Z","updated_at":"2024-03-20T22:20:32.000Z","dependencies_parsed_at":"2022-09-16T18:00:55.287Z","dependency_job_id":null,"html_url":"https://github.com/marvinhagemeister/preact-server-renderer","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marvinhagemeister%2Fpreact-server-renderer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marvinhagemeister%2Fpreact-server-renderer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marvinhagemeister%2Fpreact-server-renderer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marvinhagemeister%2Fpreact-server-renderer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/marvinhagemeister","download_url":"https://codeload.github.com/marvinhagemeister/preact-server-renderer/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249129871,"owners_count":21217455,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["nodejs","preact","ssr"],"created_at":"2024-10-01T14:20:28.351Z","updated_at":"2025-10-16T13:23:04.227Z","avatar_url":"https://github.com/marvinhagemeister.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Preact Server Renderer\n\n`preact-server-render` is similar to [preact-render-to-string](https://github.com/developit/preact-render-to-string)\nby [@developit](https://github.com/developit/) (author of preact),\nbut with pluggable formatters. This means you can easily tailer the\noutput to your needs, without any overhead. Wether you have a\nsnapshot renderer, or a custom format in mind. Performance wise,\nboth libraries are equal, only the jsx renderer is a tiny bit faster\nhere.\n\n## Installation\n\n```bash\n# npm\nnpm install preact-server-renderer\n\n# yarn\nyarn add preact-server-renderer\n```\n\n## Usage\n\n```jsx\nconst {\n  createRenderer,\n  CompactRenderer,\n  JsxRenderer,\n} = require(\"preact-server-renderer\");\n\n// Default rendering\nconst render = createRenderer(new CompactRenderer());\nconst html = render(\u003cdiv /\u003e);\n\n// JSX rendering\nconst renderJsx = createRenderer(new JsxRenderer());\nconst html2 = renderJsx(\u003cdiv /\u003e);\n\n// shallow rendering\nconst shallow = createRenderer(new CompactRenderer(), { shallow: true });\nconst html3 = shallow(\u003cdiv /\u003e);\n```\n\n### CompactRenderer\n\nThe `CompactRenderer` is the standard html renderer. It doesn't add any\nwhitespace and simply renders the components to a string.\n\nExample:\n\n```jsx\nconst { createRenderer, CompactRenderer } = require(\"preact-server-renderer\");\n\nconst render = createRenderer(new CompactRenderer());\nconsole.log(\n  render(\n    \u003cdiv class=\"foo\"\u003e\n      \u003ch1\u003eHello\u003c/h1\u003e\n    \u003c/div\u003e,\n  ),\n);\n```\n\nOutput:\n\n```txt\n\u003cdiv class=\"foo\"\u003e\u003ch1\u003eHello\u003c/h1\u003e\u003c/div\u003e\n```\n\n### JsxRenderer\n\nThis one is meant for snapshot tests, like they are found in [jest]().\n\nExample:\n\n```jsx\nconst { createRenderer, JsxRenderer } = require(\"preact-server-renderer\");\n\nconst render = createRenderer(new JsxRenderer());\nconsole.log(\n  render(\n    \u003cdiv class=\"foo\"\u003e\n      \u003ch1\u003eHello\u003c/h1\u003e\n    \u003c/div\u003e,\n  ),\n);\n```\n\nOutput:\n\n```txt\n\u003cdiv\n  class=\"foo\"\n\u003e\n  \u003ch1\u003e\n    Hello\n  \u003c/h1\u003e\n\u003c/div\u003e\n```\n\n## Writing A Custom Renderer\n\nThis is where this library really shines. Custom renderers can be easily\nplugged into the `createRenderer` function. They basically have a few callbacks\nfor the specific parsing steps. They simply need to adhere to the following\ninterface and that's it!\n\n```ts\ninterface Renderer\u003cT\u003e {\n  output: T; // Can be anything you want\n\n  /** Reset the current instance */\n  reset(): void;\n\n  /** Called when an attribute is parsed */\n  onProp(\n    name: string,\n    value: string | boolean | undefined | null,\n    depth: number,\n  ): void;\n\n  /** Called at the start of each new vnode object */\n  onOpenTag(\n    name: string,\n    hasChildren: boolean,\n    isVoid: boolean,\n    depth: number,\n  ): void;\n\n  /** Called when attribute parsing is done for the current vnode */\n  onOpenTagClose(\n    name: string,\n    hasAttributes: boolean,\n    isVoid: boolean,\n    hasChildren: boolean,\n    depth: number,\n  ): void;\n\n  /** Called when the node is a simple string */\n  onTextNode(text: string, depth: number): void;\n\n  /** Called when all children of the current vnode are parsed */\n  onCloseTag(name: string, isVoid: boolean, depth: number): void;\n\n  /** Called when vnode has it's own html (f.ex. jQuery plugins) */\n  onDangerousInnerHTML(html: string): void;\n}\n```\n\n## License\n\nMIT, see [LICENSE.md](LICENSE.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarvinhagemeister%2Fpreact-server-renderer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarvinhagemeister%2Fpreact-server-renderer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarvinhagemeister%2Fpreact-server-renderer/lists"}