forked from FusionAuth/fusionauth-site
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add Tailwind documentation (FusionAuth#2117)
add Tailwind CSS docs for Customization -> Themes
- Loading branch information
1 parent
3b3b6e9
commit ffc44bf
Showing
6 changed files
with
224 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,223 @@ | ||
--- | ||
layout: doc | ||
title: Tailwind CSS | ||
description: Detailed documentation for integrating Tailwind CSS in FusionAuth. | ||
navcategory: customization | ||
--- | ||
:page-liquid: | ||
|
||
== Overview | ||
|
||
Tailwind CSS is a utility-first CSS framework for rapidly building custom user interfaces. If you are already using Tailwind CSS in your application, you can integrate it into FusionAuth. | ||
|
||
== Prerequisites | ||
|
||
* Node.js 18 or later | ||
|
||
== Setting up FusionAuth | ||
|
||
Create a new theme by navigating to [breadcrumb]#Customization -> Themes# and then click the [uielement]#Add# button. Enter a [field]#Name# for the theme and click the [uielement]#Save# button. | ||
|
||
image::themes/tailwind/create-theme.png[Create a theme,width=1200] | ||
|
||
Create a new API key with permissions to modify the theme. You can do this by going to [breadcrumb]#Settings -> API Keys#. Then click the [uielement]#Add# button and select `GET` and `PATCH` permissions for `/api/theme/`. | ||
|
||
image::themes/tailwind/create-api-key.png[Create an API key,width=1200] | ||
|
||
== Installation | ||
|
||
To get started, we need to create a new node project with the FusionAuth CLI and Tailwind CSS installed: | ||
|
||
[source,bash] | ||
---- | ||
mkdir fusionauth-tailwind | ||
cd fusionauth-tailwind | ||
npm init -y | ||
npm install @fusionauth/cli tailwindcss@3 | ||
npx tailwindcss init | ||
---- | ||
|
||
This will install the dependencies and create the `tailwind.config.js` file in the project root. You can customize the configuration as needed. | ||
|
||
Change the `tailwind.config.js` to handle the FreeMarker template files in the `tpl` directory: | ||
|
||
[source,js] | ||
---- | ||
/** @type {import('tailwindcss').Config} */ | ||
module.exports = { | ||
content: ['./tpl/*.ftl'], | ||
theme: { | ||
extend: {} | ||
}, | ||
plugins: [] | ||
} | ||
---- | ||
|
||
Create a new stylesheet `input.css` in the root directory: | ||
|
||
[source,css] | ||
---- | ||
@tailwind base; | ||
@tailwind components; | ||
@tailwind utilities; | ||
---- | ||
|
||
This stylesheet will be used to import the Tailwind CSS base, components, and utilities. Additionally, you can add custom classes to this stylesheet as well. | ||
|
||
We can now download the theme from FusionAuth: | ||
|
||
[source,bash] | ||
---- | ||
npx fusionauth theme:download <themeId> -k <apiKey> -h http://localhost:9011 | ||
---- | ||
|
||
Replace `<themeId>` and `<apiKey>` with the Id of the theme and API key you created in FusionAuth respectively. | ||
|
||
Currently, the theme is using the `fusionauth-style.css` hosted in the FusionAuth instance. This could conflict with our Tailwind CSS file. To fix this, we need to remove the following line from the `tpl/helpers.ftl` file. It should be around line number 85: | ||
|
||
[source,html] | ||
---- | ||
<link rel="stylesheet" href="/css/fusionauth-style.css?version=${version}"/> | ||
---- | ||
|
||
Finally, we add two new scripts to the `package.json` file: | ||
|
||
[source,json] | ||
---- | ||
"scripts": { | ||
"watch:tailwind": "tailwindcss -i ./input.css -o ./tpl/stylesheet.css --watch", | ||
"watch:theme": "fusionauth theme:watch <themeId> -k <apiKey> -h http://localhost:9011" | ||
}, | ||
---- | ||
|
||
At this point, we have prepared the project to build the Tailwind CSS file and upload the theme to FusionAuth. To apply the changes in the `helper.ftl` file, run the following command: | ||
|
||
[source,bash] | ||
---- | ||
npx fusionauth theme:upload <themeId> -k <apiKey> -h http://localhost:9011 | ||
---- | ||
|
||
== Usage | ||
|
||
There are now two scripts that can be used to build the Tailwind CSS file and upload the theme to FusionAuth: | ||
|
||
* `npm run watch:theme` — watches the template directory for changes and upload the theme to FusionAuth | ||
* `npm run watch:tailwind` — watches the template directory for changes and rebuild the Tailwind CSS file | ||
|
||
If you start both scripts in separate terminal windows, you can edit the template files, which rebuild the Tailwind CSS file, and automatically upload the theme to FusionAuth. | ||
|
||
Now if we use a Tailwind CSS class in a template, it will be included in the CSS file: | ||
|
||
[source,html] | ||
---- | ||
<div class="bg-gray-200"> | ||
<h1 class="text-2xl">Hello World</h1> | ||
</div> | ||
---- | ||
|
||
To preview the changes, open FusionAuth, navigate to [breadcrumb]#Customization -> Themes#. Choose your theme, then click [uielement]#Preview#. | ||
|
||
image::themes/tailwind/preview-theme-list.png[Click preview,width=1200,role=bottom-cropped] | ||
|
||
image::themes/tailwind/preview-theme.png[Preview the theme,width=1200] | ||
|
||
== Integrate DaisyUI | ||
|
||
There are many Tailwind CSS UI component libraries available. In this example, we are going to use DaisyUI. | ||
|
||
DaisyUI is a Tailwind CSS plugin that provides a set of pre-built components and utilities to build beautiful and responsive websites. It supports color theming, light and dark mode, and RTL. | ||
|
||
To integrate DaisyUI, install the plugin: | ||
|
||
[source,bash] | ||
---- | ||
npm install daisyui | ||
---- | ||
|
||
Then add the plugin to the `tailwind.config.js`: | ||
|
||
[source,js] | ||
---- | ||
module.exports = { | ||
content: ['./tpl/*.ftl'], | ||
theme: { | ||
extend: {} | ||
}, | ||
plugins: [ | ||
require('daisyui') | ||
] | ||
} | ||
---- | ||
|
||
Now you can use the DaisyUI components in the FreeMarker template files: | ||
|
||
[source,html] | ||
---- | ||
<div class="bg-gray-200"> | ||
<h1 class="text-2xl">Hello World</h1> | ||
<div class="p-4"> | ||
<button class="btn btn-primary">Primary</button> | ||
</div> | ||
</div> | ||
---- | ||
|
||
For an example integration, see https://github.com/FusionAuth/fusionauth-example-theme-tailwind-daisyui/[FusionAuth + Tailwind + DaisyUI Repository on GitHub]. | ||
|
||
The example repository has light and dark mode setup, and includes updated templates for the following pages: | ||
|
||
* Log in | ||
* Log out | ||
* Registration | ||
* Forgot password | ||
|
||
In this repository, you could change the color scheme simply by updating the `tailwind.config.js` file: | ||
|
||
[source,js] | ||
---- | ||
/** @type {import('tailwindcss').Config} */ | ||
module.exports = { | ||
content: ['./tpl/*.ftl'], | ||
theme: { | ||
extend: { | ||
keyframes: { | ||
progressBar: { | ||
"0%": { | ||
width: "0%" | ||
}, | ||
"100%": { | ||
width: "100%" | ||
} | ||
} | ||
}, | ||
animation: { | ||
progressBar: "progressBar 10s ease-in 1" | ||
} | ||
} | ||
}, | ||
plugins: [require("daisyui")], | ||
daisyui: { | ||
themes: [ | ||
'corporate', | ||
{ | ||
business: { | ||
...require("daisyui/src/colors/themes")["[data-theme=business]"], | ||
'primary': '#c891f2' | ||
} | ||
} | ||
], | ||
darkTheme: 'business' | ||
} | ||
} | ||
---- | ||
|
||
Or you can even create your own theme with the https://daisyui.com/theme-generator/[DaisyUI Theme Generator] | ||
|
||
== Conclusion | ||
|
||
This guide has shown you how to integrate Tailwind CSS into FusionAuth using the FusionAuth CLI. Additionally, we have shown how to integrate DaisyUI to build beautiful and responsive FusionAuth pages. | ||
|
||
== References | ||
|
||
* link:https://tailwindcss.com/[Tailwind CSS] | ||
* link:https://daisyui.com/[DaisyUI] |