Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/petaki/inertia-go
⏩ Inertia.js server-side adapter for Go.
https://github.com/petaki/inertia-go
go golang inertiajs
Last synced: 6 days ago
JSON representation
⏩ Inertia.js server-side adapter for Go.
- Host: GitHub
- URL: https://github.com/petaki/inertia-go
- Owner: petaki
- License: mit
- Created: 2020-08-26T19:48:13.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-08-24T07:40:50.000Z (3 months ago)
- Last Synced: 2024-08-24T08:40:00.723Z (3 months ago)
- Topics: go, golang, inertiajs
- Language: Go
- Homepage:
- Size: 34.2 KB
- Stars: 185
- Watchers: 5
- Forks: 12
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-inertiajs - Go
README
# Inertia.js Go Adapter
[](https://github.com/petaki/inertia-go/actions)
[](LICENSE.md)
The Inertia.js server-side adapter for Go. Visit [inertiajs.com](https://inertiajs.com) to learn more.
## Installation
Install the package using the `go get` command:
```
go get github.com/petaki/inertia-go
```
## Usage
### 1. Create new instance
```go
url := "http://inertia-app.test" // Application URL for redirect
rootTemplate := "./app.gohtml" // Root template, see the example below
version := "" // Asset version
inertiaManager := inertia.New(url, rootTemplate, version)
```
Or create with `embed.FS` for root template:
```go
import "embed"
//go:embed template
var templateFS embed.FS
// ...
inertiaManager := inertia.NewWithFS(url, rootTemplate, version, templateFS)
```
### 2. Register the middleware
```go
mux := http.NewServeMux()
mux.Handle("/", inertiaManager.Middleware(homeHandler))
```
### 3. Render in handlers
```go
func homeHandler(w http.ResponseWriter, r *http.Request) {
// ...
err := inertiaManager.Render(w, r, "home/Index", nil)
if err != nil {
// Handle server error...
}
}
```
Or render with props:
```go
// ...
err := inertiaManager.Render(w, r, "home/Index", map[string]interface{}{
"total": 32,
})
//...
```
### 4. Server-side Rendering (Optional)
First, enable SSR with the url of the Node server:
```go
inertiaManager.EnableSsrWithDefault() // http://127.0.0.1:13714
```
Or with custom url:
```go
inertiaManager.EnableSsr("http://ssr-host:13714")
```
This is a simplified example using Vue 3 and Laravel Mix.
```js
// resources/js/ssr.js
import { createInertiaApp } from '@inertiajs/vue3';
import createServer from '@inertiajs/vue3/server';
import { renderToString } from '@vue/server-renderer';
import { createSSRApp, h } from 'vue';
createServer(page => createInertiaApp({
page,
render: renderToString,
resolve: name => require(`./pages/${name}`),
setup({ App, props, plugin }) {
return createSSRApp({
render: () => h(App, props)
}).use(plugin);
}
}));
```
The following config creates the `ssr.js` file in the root directory, which should not be embedded in the binary.
```js
// webpack.ssr.mix.js
const mix = require('laravel-mix');
const webpackNodeExternals = require('webpack-node-externals');
mix.options({ manifest: false })
.js('resources/js/ssr.js', '/')
.vue({
version: 3,
options: {
optimizeSSR: true
}
})
.webpackConfig({
target: 'node',
externals: [
webpackNodeExternals({
allowlist: [
/^@inertiajs/
]
})
]
});
```
You can find the example for the SSR based root template below. For more information, please read the official Server-side Rendering documentation on [inertiajs.com](https://inertiajs.com).
## Examples
The following examples show how to use the package.
### Share a prop globally
```go
inertiaManager.Share("title", "Inertia App Title")
```
### Share a function with root template
```go
inertiaManager.ShareFunc("asset", assetFunc)
```
```html
```
### Share a prop from middleware
```go
func authenticate(next http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
// ...
ctx := inertiaManager.WithProp(r.Context(), "authUserID", user.ID)
next.ServeHTTP(w, r.WithContext(ctx))
})
}
```
### Share data with root template
```go
ctx := inertiaManager.WithViewData(r.Context(), "meta", meta)
r = r.WithContext(ctx)
```
```html
```
### Root template
```html
```
### Root template with Server-side Rendering (SSR)
```html
{{ if .ssr }}
{{ raw .ssr.Head }}
{{ end }}
{{ if not .ssr }}
{{ else }}
{{ raw .ssr.Body }}
{{ end }}
```
## Example Apps
### Satellite
https://github.com/petaki/satellite
### Homettp
https://github.com/homettp/homettp
### Waterkube
https://github.com/waterkube/waterkube
## Reporting Issues
If you are facing a problem with this package or found any bug, please open an issue on [GitHub](https://github.com/petaki/inertia-go/issues).
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.