Documentation
¶
Index ¶
- Constants
- Variables
- func APIConfigGetName() string
- func CssConfigGetName() string
- func EsbuildConfigGetName() string
- func FilterAllowedQueryParams(req *http.Request, allowedKeys []string) url.Values
- func GojaRenderConfigGetName() string
- func HTMLConfigGetName() string
- func JSConfigGetName() string
- func JavaScriptConfigGetName() string
- func LocalJSONConfigGetName() string
- func MarkdownConfigGetName() string
- func MenuConfigGetName() string
- func MultipleImagesConfigGetName() string
- func PluginRenderGetName() string
- func SingleImageConfigGetName() string
- func SortHyperMediasBySection(pagesBySection map[string][]composite.HyperMediaConfig, options SortOptions) (map[string][]composite.HyperMediaConfig, error)
- func StyleConfigGetName() string
- func TextConfigGetName() string
- type APIConfig
- type APIRenderer
- type ApiRenderConfig
- type CssConfig
- type CssRenderer
- type EsbuildConfig
- type EsbuildRenderer
- func (r *EsbuildRenderer) AssetFailure() error
- func (r *EsbuildRenderer) BeginAssetSession() error
- func (r *EsbuildRenderer) CloseAssets()
- func (r *EsbuildRenderer) HasPendingAssetCleanup() bool
- func (r *EsbuildRenderer) Invalidate()
- func (r *EsbuildRenderer) OwnsOutput(path string) bool
- func (r *EsbuildRenderer) Prepare(config EsbuildConfig) *PreparedEsbuild
- func (r *EsbuildRenderer) ReconcileAssets(active map[string]int) error
- func (r *EsbuildRenderer) Render(instance interface{}, ctx context.Context) (string, []error)
- func (r *EsbuildRenderer) ScheduleAssetReconciliation(active map[string]int)
- func (r *EsbuildRenderer) SetAssetProtection(protect func(string) bool)
- func (r *EsbuildRenderer) Types() []string
- type GojaRenderConfig
- type GojaRenderer
- type HTMLConfig
- type HTMLRenderer
- type HyperMediaConfig
- type ImageAssetPolicy
- type ImageProcessor
- func (p *ImageProcessor) BeginAssetSession(dest string) error
- func (p *ImageProcessor) CloseAssets()
- func (p *ImageProcessor) DiscoverImages(single *SingleImageConfig, multiple *MultipleImagesConfig) (map[string]imagePolicy, error)
- func (p *ImageProcessor) HasPendingAssetCleanup() bool
- func (p *ImageProcessor) OwnsOutput(path string) bool
- func (ir *ImageProcessor) ProcessMultipleImages(config MultipleImagesConfig) (string, error)
- func (ir *ImageProcessor) ProcessSingleImage(config SingleImageConfig) (string, error)
- func (p *ImageProcessor) ReconcileAssets(dest string, active map[string]imagePolicy) error
- func (ir *ImageProcessor) Render(instance interface{}, ctx context.Context) (string, error)
- func (p *ImageProcessor) ScheduleAssetReconciliation(dest string, active map[string]ImageAssetPolicy) error
- func (p *ImageProcessor) SetAssetProtection(protect func(string) bool)
- type JSConfig
- type JSRenderer
- type JavaScriptConfig
- type JavaScriptRenderer
- type LocalJSONConfig
- type LocalJSONRenderer
- type MarkdownConfig
- type MarkdownRenderer
- type MenuConfig
- type MenuRenderer
- type MultipleImagesConfig
- type MultipleImagesRenderer
- type PluginConfig
- type PluginRenderer
- type PreparedEsbuild
- type PreparedGojaRender
- type RenderImageConfig
- type SingleImageConfig
- type SingleImageRenderer
- type SortOptions
- type StyleConfig
- type StyleRenderer
- type TextConfig
- type TextRenderer
Constants ¶
const DefaultMarkdownMaxBytes = markdown.DefaultMaxBytes
const EsbuildPreparedKey = "@esbuild_prepared"
const GojaPreparedKey = "@goja_prepared"
GojaPreparedKey is runtime-only metadata owned by the loaded route snapshot.
const MaxMarkdownBytes = markdown.MaxBytes
Variables ¶
Functions ¶
func APIConfigGetName ¶
func APIConfigGetName() string
func CssConfigGetName ¶
func CssConfigGetName() string
func EsbuildConfigGetName ¶
func EsbuildConfigGetName() string
func FilterAllowedQueryParams ¶
FilterAllowedQueryParams returns only the query parameters whose keys are in allowedKeys. If allowedKeys is empty, it returns an empty url.Values (no parameters).
func GojaRenderConfigGetName ¶
func GojaRenderConfigGetName() string
func HTMLConfigGetName ¶
func HTMLConfigGetName() string
func JSConfigGetName ¶
func JSConfigGetName() string
func JavaScriptConfigGetName ¶
func JavaScriptConfigGetName() string
JavaScriptConfigGetName returns the explicit JavaScript component alias.
func LocalJSONConfigGetName ¶
func LocalJSONConfigGetName() string
func MarkdownConfigGetName ¶
func MarkdownConfigGetName() string
func MenuConfigGetName ¶
func MenuConfigGetName() string
func MultipleImagesConfigGetName ¶
func MultipleImagesConfigGetName() string
func PluginRenderGetName ¶
func PluginRenderGetName() string
func SingleImageConfigGetName ¶
func SingleImageConfigGetName() string
func SortHyperMediasBySection ¶
func SortHyperMediasBySection(pagesBySection map[string][]composite.HyperMediaConfig, options SortOptions) (map[string][]composite.HyperMediaConfig, error)
func StyleConfigGetName ¶
func StyleConfigGetName() string
func TextConfigGetName ¶
func TextConfigGetName() string
Types ¶
type APIConfig ¶
type APIConfig struct {
shared.Component `mapstructure:",squash"`
ApiRenderConfig `mapstructure:",squash"`
MetaDocDescription string `` /* 233-byte string literal not displayed */
}
func (APIConfig) ValidateRawConfig ¶
ValidateRawConfig owns the strict type contract for this API component's authentication and response-status fields before ordinary weak decoding.
type APIRenderer ¶
type APIRenderer struct {
renderer.ComponentRenderer
}
func (*APIRenderer) Render ¶
func (pr *APIRenderer) Render(instance interface{}, ctx context.Context) (string, []error)
func (*APIRenderer) Types ¶
func (r *APIRenderer) Types() []string
type ApiRenderConfig ¶
type ApiRenderConfig struct {
Endpoint string `` /* 126-byte string literal not displayed */
ForwardToken string `` /* 268-byte string literal not displayed */
Method string `` /* 167-byte string literal not displayed */
Headers map[string]string `` /* 208-byte string literal not displayed */
Body string `` /* 172-byte string literal not displayed */
Template string `` /* 157-byte string literal not displayed */
Inline string `` /* 199-byte string literal not displayed */
Values map[string]interface{} `mapstructure:"values" description:"Key-value pairs for template rendering" example:"{!{api-render-values.hyperbricks.yaml}}"`
Username string `` /* 150-byte string literal not displayed */
Password string `` /* 150-byte string literal not displayed */
Status int `mapstructure:"status" exclude:"true"` // This adds {{.Status}} to the root level of the template data
AllowedQueryKeys []string `` /* 225-byte string literal not displayed */
QueryParams map[string]string `` /* 222-byte string literal not displayed */
JwtSecret string `` /* 218-byte string literal not displayed */
JwtClaims map[string]string `` /* 144-byte string literal not displayed */
Debug bool `` /* 178-byte string literal not displayed */
DebugPanel bool `` /* 186-byte string literal not displayed */
ResponseStatus *shared.ResponseStatusConfig `` /* 282-byte string literal not displayed */
}
type CssConfig ¶
type CssConfig struct {
shared.Component `mapstructure:",squash"`
MetaDocDescription string `` /* 141-byte string literal not displayed */
Inline string `` /* 184-byte string literal not displayed */
Link string `mapstructure:"link" description:"Use link for a link tag" example:"{!{css-link.hyperbricks.yaml}}"`
File string `` /* 165-byte string literal not displayed */
}
type CssRenderer ¶
type CssRenderer struct{}
func (*CssRenderer) Render ¶
func (sr *CssRenderer) Render(instance interface{}, ctx context.Context) (string, []error)
func (*CssRenderer) Types ¶
func (r *CssRenderer) Types() []string
type EsbuildConfig ¶
type EsbuildConfig struct {
shared.Component `mapstructure:",squash"`
MetaDocDescription string `` /* 146-byte string literal not displayed */
Entry string `mapstructure:"entry" validate:"required" description:"Source filename. Use path with an explicit resources base."`
Outfile string `` /* 146-byte string literal not displayed */
Binary string `mapstructure:"binary" description:"Optional external esbuild executable; empty uses the embedded Go API."`
Minify bool `mapstructure:"minify" description:"Minify whitespace and syntax. Default false."`
MinifyIdentifiers bool `` /* 165-byte string literal not displayed */
Mangle bool `` /* 172-byte string literal not displayed */
Sourcemap bool `mapstructure:"sourcemap" description:"Emit a linked source map. Default false."`
Debug bool `mapstructure:"debug" description:"Log effective build options, engine, and cache diagnostics."`
CacheKeep int `` /* 189-byte string literal not displayed */
Cache bool `` /* 146-byte string literal not displayed */
Fingerprint bool `` /* 199-byte string literal not displayed */
Target []string `mapstructure:"target" description:"Optional browser/language targets, e.g. chrome110, safari16, es2020."`
Loader map[string]string `mapstructure:"loader" description:"Extension loader overrides, e.g. .woff2: file or .png: dataurl."`
External []string `mapstructure:"external" description:"Import or asset URL patterns to leave unbundled, e.g. /static/vendor/*."`
Prepared interface{} `mapstructure:"@esbuild_prepared" json:"-" exclude:"true"`
}
type EsbuildRenderer ¶
type EsbuildRenderer struct {
// contains filtered or unexported fields
}
func NewEsbuildRenderer ¶
func NewEsbuildRenderer(staticDir string) *EsbuildRenderer
func (*EsbuildRenderer) AssetFailure ¶
func (r *EsbuildRenderer) AssetFailure() error
AssetFailure reports an ownership/retention failure from this loaded configuration, allowing the CLI to classify a failed snapshot accurately.
func (*EsbuildRenderer) BeginAssetSession ¶
func (r *EsbuildRenderer) BeginAssetSession() error
BeginAssetSession excludes another runtime/export using the same output root. File locks are released by the OS on process exit as well as by CloseAssets.
func (*EsbuildRenderer) CloseAssets ¶
func (r *EsbuildRenderer) CloseAssets()
func (*EsbuildRenderer) HasPendingAssetCleanup ¶
func (r *EsbuildRenderer) HasPendingAssetCleanup() bool
HasPendingAssetCleanup reports obsolete generations whose removal was deferred while their outputs were protected. Ordinary requests do no I/O.
func (*EsbuildRenderer) Invalidate ¶
func (r *EsbuildRenderer) Invalidate()
Invalidate preserves the publication lock across reloads and in-flight requests.
func (*EsbuildRenderer) OwnsOutput ¶
func (r *EsbuildRenderer) OwnsOutput(path string) bool
OwnsOutput identifies paths generated in this session, including removed generations whose queued filesystem events must not trigger source reloads. It is not the durable ownership evidence used to delete files.
func (*EsbuildRenderer) Prepare ¶
func (r *EsbuildRenderer) Prepare(config EsbuildConfig) *PreparedEsbuild
func (*EsbuildRenderer) ReconcileAssets ¶
func (r *EsbuildRenderer) ReconcileAssets(active map[string]int) error
ReconcileAssets is called only after complete successful owner discovery. nil active means enforce retention without declaring any owners orphaned.
func (*EsbuildRenderer) Render ¶
func (r *EsbuildRenderer) Render(instance interface{}, ctx context.Context) (string, []error)
func (*EsbuildRenderer) ScheduleAssetReconciliation ¶
func (r *EsbuildRenderer) ScheduleAssetReconciliation(active map[string]int)
ScheduleAssetReconciliation records complete owner discovery without deleting files. Active API renders may need nested requests before they can finish; cleanup retries under the exclusive runtime gate after those requests finish.
func (*EsbuildRenderer) SetAssetProtection ¶
func (r *EsbuildRenderer) SetAssetProtection(protect func(string) bool)
SetAssetProtection lets the runtime protect outputs referenced by requests and response caches. The callback must not call back into this renderer.
func (*EsbuildRenderer) Types ¶
func (r *EsbuildRenderer) Types() []string
type GojaRenderConfig ¶
type GojaRenderConfig struct {
shared.Component `mapstructure:",squash"`
MetaDocDescription string `` /* 149-byte string literal not displayed */
Script string `` /* 142-byte string literal not displayed */
Template string `mapstructure:"template" description:"Preloaded Go template file. The script result is available as .Data."`
Inline string `mapstructure:"inline" description:"Inline Go HTML template. Mutually exclusive with template."`
Values map[string]interface{} `mapstructure:"values" description:"Plain input data, copied into each script execution. Nested components are not rendered."`
AllowedQueryKeys []string `mapstructure:"querykeys" description:"Explicitly allowed query keys. No query parameters are exposed by default."`
Timeout string `mapstructure:"timeout" description:"Script deadline, default 100ms. Must be positive and at most 5s."`
Prepared interface{} `mapstructure:"@goja_prepared" json:"-" exclude:"true"`
}
type GojaRenderer ¶
type GojaRenderer struct{}
func (*GojaRenderer) Render ¶
func (r *GojaRenderer) Render(instance interface{}, ctx context.Context) (string, []error)
func (*GojaRenderer) Types ¶
func (r *GojaRenderer) Types() []string
type HTMLConfig ¶
type HTMLConfig struct {
shared.Component `mapstructure:",squash"`
MetaDocDescription string `mapstructure:"@doc" description:"Component for rendering raw HTML snippets." example:"{!{html-@doc.hyperbricks.yaml}}"`
Value string `mapstructure:"value" validate:"required" description:"The raw HTML content" example:"{!{html-value.hyperbricks.yaml}}"`
TrimSpace bool `` /* 173-byte string literal not displayed */
}
func (*HTMLConfig) Validate ¶
func (hc *HTMLConfig) Validate() []error
type HTMLRenderer ¶
type HTMLRenderer struct{}
func (*HTMLRenderer) Render ¶
func (hr *HTMLRenderer) Render(instance interface{}, ctx context.Context) (string, []error)
func (*HTMLRenderer) Types ¶
func (r *HTMLRenderer) Types() []string
type HyperMediaConfig ¶
type ImageAssetPolicy ¶
type ImageAssetPolicy = imagePolicy
ImageAssetPolicy is the retention policy discovered from effective configs.
type ImageProcessor ¶
type ImageProcessor struct {
// contains filtered or unexported fields
}
func NewImageProcessor ¶
func NewImageProcessor() *ImageProcessor
NewImageProcessor shares generation ownership across IMAGE and IMAGES. Zero-value processors remain usable for component consumers.
func (*ImageProcessor) BeginAssetSession ¶
func (p *ImageProcessor) BeginAssetSession(dest string) error
func (*ImageProcessor) CloseAssets ¶
func (p *ImageProcessor) CloseAssets()
func (*ImageProcessor) DiscoverImages ¶
func (p *ImageProcessor) DiscoverImages(single *SingleImageConfig, multiple *MultipleImagesConfig) (map[string]imagePolicy, error)
DiscoverImages returns effective owners without decoding or generating images. A complete successful discovery is required before declaring owners orphaned.
func (*ImageProcessor) HasPendingAssetCleanup ¶
func (p *ImageProcessor) HasPendingAssetCleanup() bool
func (*ImageProcessor) OwnsOutput ¶
func (p *ImageProcessor) OwnsOutput(path string) bool
func (*ImageProcessor) ProcessMultipleImages ¶
func (ir *ImageProcessor) ProcessMultipleImages(config MultipleImagesConfig) (string, error)
func (*ImageProcessor) ProcessSingleImage ¶
func (ir *ImageProcessor) ProcessSingleImage(config SingleImageConfig) (string, error)
func (*ImageProcessor) ReconcileAssets ¶
func (p *ImageProcessor) ReconcileAssets(dest string, active map[string]imagePolicy) error
func (*ImageProcessor) Render ¶
func (ir *ImageProcessor) Render(instance interface{}, ctx context.Context) (string, error)
func (*ImageProcessor) ScheduleAssetReconciliation ¶
func (p *ImageProcessor) ScheduleAssetReconciliation(dest string, active map[string]ImageAssetPolicy) error
ScheduleAssetReconciliation records effective owners without deleting output while active API renders may still require nested local asset requests.
func (*ImageProcessor) SetAssetProtection ¶
func (p *ImageProcessor) SetAssetProtection(protect func(string) bool)
type JSConfig ¶
type JSConfig struct {
shared.Component `mapstructure:",squash"`
MetaDocDescription string `` /* 156-byte string literal not displayed */
Inline string `` /* 198-byte string literal not displayed */
Link string `` /* 128-byte string literal not displayed */
File string `` /* 173-byte string literal not displayed */
}
type JSRenderer ¶
type JSRenderer struct{}
func (*JSRenderer) Render ¶
func (jsr *JSRenderer) Render(instance interface{}, ctx context.Context) (string, []error)
func (*JSRenderer) Types ¶
func (r *JSRenderer) Types() []string
type LocalJSONConfig ¶
type LocalJSONConfig struct {
shared.Component `mapstructure:",squash"`
MetaDocDescription string `` /* 465-byte string literal not displayed */
FilePath string `mapstructure:"file" validate:"required" description:"Path to the local JSON file" example:"{!{json-file.hyperbricks.yaml}}"`
Template string `` /* 151-byte string literal not displayed */
Inline string `` /* 224-byte string literal not displayed */
Values map[string]interface{} `mapstructure:"values" description:"Key-value pairs for template rendering" example:"{!{json-values.hyperbricks.yaml}}"`
Debug bool `mapstructure:"debug" description:"Debug the response data" example:"{!{json-debug.hyperbricks.yaml}}"`
}
func (*LocalJSONConfig) Validate ¶
func (config *LocalJSONConfig) Validate() []error
type LocalJSONRenderer ¶
func (*LocalJSONRenderer) Render ¶
func (renderer *LocalJSONRenderer) Render(instance interface{}, ctx context.Context) (string, []error)
func (*LocalJSONRenderer) Types ¶
func (r *LocalJSONRenderer) Types() []string
type MarkdownConfig ¶
type MarkdownConfig struct {
shared.Component `mapstructure:",squash"`
MetaDocDescription string `` /* 193-byte string literal not displayed */
Content *string `` /* 182-byte string literal not displayed */
File string `` /* 169-byte string literal not displayed */
Class string `mapstructure:"class" description:"Optional escaped CSS class for a wrapping div. Empty emits only Markdown HTML."`
MaxBytes int64 `` /* 131-byte string literal not displayed */
Editable interface{} `` /* 133-byte string literal not displayed */
Cache bool `` /* 191-byte string literal not displayed */
}
func (MarkdownConfig) ValidateRawConfig ¶
func (config MarkdownConfig) ValidateRawConfig(raw map[string]interface{}) error
type MarkdownRenderer ¶
type MarkdownRenderer struct {
ResourcesRoot string
// contains filtered or unexported fields
}
func NewMarkdownRenderer ¶
func NewMarkdownRenderer(resources string) *MarkdownRenderer
func (*MarkdownRenderer) Render ¶
func (r *MarkdownRenderer) Render(instance interface{}, ctx context.Context) (string, []error)
func (*MarkdownRenderer) Types ¶
func (r *MarkdownRenderer) Types() []string
type MenuConfig ¶
type MenuConfig struct {
shared.Component `mapstructure:",squash"`
Section string `` /* 137-byte string literal not displayed */
Order string `` /* 153-byte string literal not displayed */
Sort string `` /* 174-byte string literal not displayed */
Active string `` /* 134-byte string literal not displayed */
Item string `` /* 128-byte string literal not displayed */
Enclose string `mapstructure:"enclose" description:"Template to enclose the menu items." example:"{!{menu-enclose.hyperbricks.yaml}}"`
HyperMediasBySection map[string][]composite.HyperMediaConfig
}
func (*MenuConfig) Validate ¶
func (mc *MenuConfig) Validate() []error
type MenuRenderer ¶
type MenuRenderer struct {
TemplateProvider func(templateName string) (string, bool)
HyperMediasBySection map[string][]composite.HyperMediaConfig
}
func (*MenuRenderer) Render ¶
func (mr *MenuRenderer) Render(instance interface{}, ctx context.Context) (string, []error)
func (*MenuRenderer) Types ¶
func (r *MenuRenderer) Types() []string
type MultipleImagesConfig ¶
type MultipleImagesConfig struct {
shared.Component `mapstructure:",squash"`
MetaDocDescription string `` /* 330-byte string literal not displayed */
Cache bool `` /* 197-byte string literal not displayed */
CacheKeep int `` /* 199-byte string literal not displayed */
CacheGrace string `` /* 205-byte string literal not displayed */
Directory string `` /* 271-byte string literal not displayed */
Width int `` /* 227-byte string literal not displayed */
Height int `` /* 234-byte string literal not displayed */
Id string `mapstructure:"id" description:"Id of images with a index added to it" example:"{!{images-id.hyperbricks.yaml}}"`
Class string `mapstructure:"class" description:"CSS class for styling the image" example:"{!{images-class.hyperbricks.yaml}}"`
IsStatic bool `` /* 143-byte string literal not displayed */
Alt string `` /* 237-byte string literal not displayed */
Title string `mapstructure:"title" description:"The title attribute of the image" example:"{!{images-title.hyperbricks.yaml}}"`
Quality int `` /* 179-byte string literal not displayed */
Loading string `` /* 129-byte string literal not displayed */
// contains filtered or unexported fields
}
func (*MultipleImagesConfig) Validate ¶
func (config *MultipleImagesConfig) Validate() []error
type MultipleImagesRenderer ¶
type MultipleImagesRenderer struct {
ImageProcessorInstance *ImageProcessor
}
func (*MultipleImagesRenderer) Render ¶
func (mir *MultipleImagesRenderer) Render(instance interface{}, ctx context.Context) (string, []error)
func (*MultipleImagesRenderer) Types ¶
func (r *MultipleImagesRenderer) Types() []string
type PluginConfig ¶
type PluginConfig struct {
shared.Component `mapstructure:",squash"`
PluginName string `mapstructure:"plugin" description:"Name of the plugin to render"`
Classes []string `` /* 134-byte string literal not displayed */
Data map[string]interface{} `mapstructure:"data" description:"Plugin-specific data passed to the renderer"`
}
type PluginRenderer ¶
type PluginRenderer struct {
renderer.CompositeRenderer
}
func (*PluginRenderer) LoadAndRender ¶
func (r *PluginRenderer) LoadAndRender(instance interface{}, ctx context.Context) (string, []error)
func (*PluginRenderer) Render ¶
func (r *PluginRenderer) Render(instance interface{}, ctx context.Context) (string, []error)
func (*PluginRenderer) Types ¶
func (r *PluginRenderer) Types() []string
type PreparedEsbuild ¶
type PreparedEsbuild struct {
// contains filtered or unexported fields
}
func (*PreparedEsbuild) BuildIdentity ¶
func (p *PreparedEsbuild) BuildIdentity() (string, string)
BuildIdentity excludes presentation and caching policy, so inherited wrappers may share output without changing where or how the HTML is rendered.
func (*PreparedEsbuild) Err ¶
func (p *PreparedEsbuild) Err() error
func (*PreparedEsbuild) RejectOutputConflict ¶
func (p *PreparedEsbuild) RejectOutputConflict()
RejectOutputConflict is called by the loader before publishing the snapshot.
func (*PreparedEsbuild) Render ¶
func (p *PreparedEsbuild) Render(ctx context.Context) (string, []error)
func (*PreparedEsbuild) RetainedGenerations ¶
func (p *PreparedEsbuild) RetainedGenerations() int
type PreparedGojaRender ¶
type PreparedGojaRender struct {
// contains filtered or unexported fields
}
PreparedGojaRender owns immutable load-time resources, not execution state.
func PrepareGojaRender ¶
func PrepareGojaRender(config GojaRenderConfig, provider func(string) (string, bool)) *PreparedGojaRender
func (*PreparedGojaRender) Err ¶
func (p *PreparedGojaRender) Err() error
func (*PreparedGojaRender) QueryKeys ¶
func (p *PreparedGojaRender) QueryKeys() []string
type RenderImageConfig ¶
type RenderImageConfig struct {
Single *SingleImageConfig `mapstructure:"single"`
Multiple *MultipleImagesConfig `mapstructure:"multiple"`
}
type SingleImageConfig ¶
type SingleImageConfig struct {
shared.Component `mapstructure:",squash"`
MetaDocDescription string `` /* 323-byte string literal not displayed */
Cache bool `` /* 196-byte string literal not displayed */
CacheKeep int `` /* 198-byte string literal not displayed */
CacheGrace string `` /* 204-byte string literal not displayed */
Editable interface{} `` /* 159-byte string literal not displayed */
Src string `` /* 289-byte string literal not displayed */
Width int `` /* 225-byte string literal not displayed */
Height int `` /* 233-byte string literal not displayed */
Alt string `` /* 236-byte string literal not displayed */
Title string `mapstructure:"title" description:"The title attribute of the image" example:"{!{image-title.hyperbricks.yaml}}"`
Id string `mapstructure:"id" description:"Id of image" example:"{!{image-id.hyperbricks.yaml}}"`
Class string `mapstructure:"class" description:"CSS class for styling the image" example:"{!{image-class.hyperbricks.yaml}}"`
Quality int `` /* 178-byte string literal not displayed */
Loading string `` /* 128-byte string literal not displayed */
IsStatic bool `` /* 140-byte string literal not displayed */
// contains filtered or unexported fields
}
func (*SingleImageConfig) Validate ¶
func (config *SingleImageConfig) Validate() []error
type SingleImageRenderer ¶
type SingleImageRenderer struct {
ImageProcessorInstance *ImageProcessor
}
func (*SingleImageRenderer) Render ¶
func (sir *SingleImageRenderer) Render(instance interface{}, ctx context.Context) (string, []error)
func (*SingleImageRenderer) Types ¶
func (r *SingleImageRenderer) Types() []string
type SortOptions ¶
type StyleConfig ¶
type StyleConfig struct {
shared.Component `mapstructure:",squash"`
File string `mapstructure:"file" validate:"required" description:"Path to the CSS file" example:"{!{styles-file.hyperbricks.yaml}}"`
}
func (*StyleConfig) Validate ¶
func (style *StyleConfig) Validate() []error
type StyleRenderer ¶
type StyleRenderer struct{}
func (*StyleRenderer) Render ¶
func (sr *StyleRenderer) Render(instance interface{}, ctx context.Context) (string, []error)
func (*StyleRenderer) Types ¶
func (r *StyleRenderer) Types() []string
type TextConfig ¶
type TextConfig struct {
shared.Component `mapstructure:",squash"`
MetaDocDescription string `mapstructure:"@doc" description:"Render simple text" example:"{!{text-@doc.hyperbricks.yaml}}"`
Value string `` /* 188-byte string literal not displayed */
}
func (*TextConfig) Validate ¶
func (tc *TextConfig) Validate() []error
type TextRenderer ¶
type TextRenderer struct{}
func (*TextRenderer) Render ¶
func (tr *TextRenderer) Render(instance interface{}, ctx context.Context) (string, []error)
func (*TextRenderer) Types ¶
func (r *TextRenderer) Types() []string