Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fixed api parameter names for simple themes #3118

Merged
merged 1 commit into from
Jun 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@
The type of the Theme. This value determines what content is required for the Theme. There are two distinct values.
* `advanced` - This is the default FusionAuth theme type. This type allows for full customization of the html, css, and messaging via [Freemarker](https://freemarker.apache.org) templates. If a Theme is `advanced` then the <InlineField>theme.defaultMessages</InlineField> and <InlineField>theme.templates</InlineField> fields are required. The <InlineField>theme.defaultMessages</InlineField> should specify every message in the message bundle. See [Theme Localization](/docs/customize/look-and-feel/localization).
* `simple` - A simple theme only requires a set of variables that will applied to css across the theme. If a Theme is `simple` then the <InlineField>theme.variables</InlineField> field is required. If a theme is `simple` then the <InlineField>theme.defaultMessages</InlineField> need only specify any text that you would like to change from what is included in theme.
</APIField>
</APIField>
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ import InlineField from 'src/components/InlineField.astro';
The color of the font in the alert message. [Colors](https://developer.mozilla.org/en-US/docs/Web/CSS/color) must be a valid hex color code, RGB, or HSL value.
</APIField>

<APIField name={(props.search ? "themes[x]." : "theme.") + "variables.backgroundImageUrl"} type="String" optional>
<APIField name={(props.search ? "themes[x]." : "theme.") + "variables.backgroundImageURL"} type="String" optional>
The url of the background image. Will replace the page background color. Must be a valid absolute URL.
</APIField>

<APIField name={(props.search ? "themes[x]." : "theme.") + "variables.backgroundSize"} type="String" optional>
Specifies the [background-size](https://developer.mozilla.org/en-US/docs/Web/CSS/background-size) of the background image. Valid values are `repeat`, `contain`, and `cover`.

Required if <InlineField>theme.variables.backgroundImageUrl</InlineField> is provided.
Required if <InlineField>theme.variables.backgroundImageURL</InlineField> is provided.
</APIField>

<APIField name={(props.search ? "themes[x]." : "theme.") + "variables.borderRadius"} type="String" required>
Expand Down Expand Up @@ -94,10 +94,10 @@ import InlineField from 'src/components/InlineField.astro';
<APIField name={(props.search ? "themes[x]." : "theme.") + "variables.logoImageSize"} type="String" optional>
The size of the logo image. Must be a valid numeric value with a `px`, `em`, or `rem` suffix.

Required if <InlineField>theme.variables.logoImageUrl</InlineField> is provided.
Required if <InlineField>theme.variables.logoImageURL</InlineField> is provided.
</APIField>

<APIField name={(props.search ? "themes[x]." : "theme.") + "variables.logoImageUrl"} type="String" optional>
<APIField name={(props.search ? "themes[x]." : "theme.") + "variables.logoImageURL"} type="String" optional>
The url of the logo image. Must be a valid absolute URL. Can be `null`.
</APIField>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import InlineField from 'src/components/InlineField.astro';
The color of the font in the alert message.
</APIField>

<APIField name={(props.search ? "themes[x]." : "theme.") + "variables.backgroundImageUrl"} type="String" optional>
<APIField name={(props.search ? "themes[x]." : "theme.") + "variables.backgroundImageURL"} type="String" optional>
The url of the background image. Will replace the page background color.
</APIField>

Expand Down Expand Up @@ -93,7 +93,7 @@ import InlineField from 'src/components/InlineField.astro';
The size of the logo image.
</APIField>

<APIField name={(props.search ? "themes[x]." : "theme.") + "variables.logoImageUrl"} type="String" optional>
<APIField name={(props.search ? "themes[x]." : "theme.") + "variables.logoImageURL"} type="String" optional>
The url of the logo image.
</APIField>

Expand Down
4 changes: 2 additions & 2 deletions astro/src/content/json/themes/responses.json
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@
"variables": {
"alertBackgroundColor": "#ffffff",
"alertFontColor": "#ffffff",
"backgroundImageUrl": "https://example.com/mybackground.png",
"backgroundImageURL": "https://example.com/mybackground.png",
"backgroundRepeat": "no-repeat",
"backgroundSize": "cover",
"borderRadius": "1.00rem",
Expand All @@ -95,7 +95,7 @@
"linkTextFocusColor": "#cccccc",
"logoImageDisplay": "flex",
"logoImageSize": "7rem",
"logoImageUrl": "https://example.com/mylogo.png",
"logoImageURL": "https://example.com/mylogo.png",
"monoFontColor": "#ffffff",
"monoFontFamily": "monospace",
"pageBackgroundColor": "#ffffff",
Expand Down
4 changes: 2 additions & 2 deletions astro/src/content/json/themes/search-response.json
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@
"variables": {
"alertBackgroundColor": "#ffffff",
"alertFontColor": "#ffffff",
"backgroundImageUrl": "https://example.com/mybackground.png",
"backgroundImageURL": "https://example.com/mybackground.png",
"backgroundRepeat": "no-repeat",
"backgroundSize": "cover",
"borderRadius": "1.00rem",
Expand All @@ -95,7 +95,7 @@
"linkTextFocusColor": "#cccccc",
"logoImageDisplay": "flex",
"logoImageSize": "7rem",
"logoImageUrl": "https://example.com/mylogo.png",
"logoImageURL": "https://example.com/mylogo.png",
"monoFontColor": "#ffffff",
"monoFontFamily": "monospace",
"pageBackgroundColor": "#ffffff",
Expand Down
6 changes: 3 additions & 3 deletions astro/src/content/json/themes/simple-request.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
"variables": {
"alertBackgroundColor": "#ffffff",
"alertFontColor": "#ffffff",
"backgroundImageUrl": "https://example.com/mybackground.png",
"backgroundImageURL": "https://example.com/mybackground.png",
"backgroundRepeat": "no-repeat",
"backgroundSize": "cover",
"borderRadius": "1.00rem",
Expand All @@ -34,7 +34,7 @@
"linkTextFocusColor": "#cccccc",
"logoImageDisplay": "flex",
"logoImageSize": "7rem",
"logoImageUrl": "https://example.com/mylogo.png",
"logoImageURL": "https://example.com/mylogo.png",
"monoFontColor": "#ffffff",
"monoFontFamily": "monospace",
"pageBackgroundColor": "#ffffff",
Expand All @@ -45,4 +45,4 @@
"primaryButtonTextFocusColor": "#cccccc"
}
}
}
}
6 changes: 3 additions & 3 deletions astro/src/content/json/themes/simple-response.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
"variables": {
"alertBackgroundColor": "#ffffff",
"alertFontColor": "#ffffff",
"backgroundImageUrl": "https://example.com/mybackground.png",
"backgroundImageURL": "https://example.com/mybackground.png",
"backgroundRepeat": "no-repeat",
"backgroundSize": "cover",
"borderRadius": "1.00rem",
Expand All @@ -37,7 +37,7 @@
"linkTextFocusColor": "#cccccc",
"logoImageDisplay": "flex",
"logoImageSize": "7rem",
"logoImageUrl": "https://example.com/mylogo.png",
"logoImageURL": "https://example.com/mylogo.png",
"monoFontColor": "#ffffff",
"monoFontFamily": "monospace",
"pageBackgroundColor": "#ffffff",
Expand All @@ -48,4 +48,4 @@
"primaryButtonTextFocusColor": "#cccccc"
}
}
}
}
Loading