Class SettingsSpaOptions
- Namespace
- OpenSettings.AspNetCore.Spa
- Assembly
- OpenSettings.AspNetCore.Spa.dll
Represents the configuration options for the OpenSettings page.
This class allows customization of various settings related to the page behavior and appearance.
It includes properties for managing the index stream and document title, among other settings.
public class SettingsSpaOptions
- Inheritance
-
SettingsSpaOptions
- Inherited Members
Properties
DocumentTitle
Gets or sets the title of the document for the settings page.
The default value is 'OpenSettings Spa
'.
This title is used in the HTML document's title element and will be displayed in the browser's title bar.
public string DocumentTitle { get; set; }
Property Value
IndexStream
Gets or sets a function that returns a Stream representing the index HTML file for the open settings spa.
This function retrieves the embedded resource stream for the specified HTML file.
The default implementation uses the SettingsSpaOptions type's assembly to access the embedded resource.
public Func<Stream> IndexStream { get; set; }
Property Value
RoutePrefix
Specifies the prefix used to access the OpenSettings page.
The default value is 'settings
'.
With this prefix, the OpenSettings page can be accessed through the defined route.
public string RoutePrefix { get; set; }