基于Angular 8和Bootstrap 4实现动态主题切换的示例代码
效果
首先看看效果:
本文将介绍如何基于Angular8和Bootstrap4来实现上面的主题切换效果。
设计
遵循Bootstrap的设计,我们会使用bootswatch.com提供的免费主题来实现上面的效果。Bootswatch为前端程序员提供了多达21种免费的Bootstrap主题,并且提供了API文档和实例页面,介绍如何在HTML+jQuery的环境中实现主题切换。其实,我们也可以使用Bootstrap官网提供的主题设计工具来设计自己的主题,这些自定义的主题也是可以用在本文介绍的方法里的,只需要替换相关的资源地址就可以。如果你打开Bootswatch的API,你就会看到各种主题的元数据信息,我们可以使用其中的cssMin链接来替换主页的link地址,以达到切换主题的目的。
在开工之前,还是要做一些粗略的设计。为了简单起见,我使用Bootstrap的Navbar来完成这个功能,因为Navbar的代码可以直接从Bootstrap官网拷贝过来,稍微改改就行。不同的是,我将Navbar封装在一个组件(Component)里,这样做的好处是,可以将切换主题的功能封装起来,以实现模块化的设计。下图展示了这一设计:
基本流程如下:
- theme.service.ts提供从Bootswatch获取主题信息的服务
- 主应用app.component.ts调用theme.service.ts,获取主题信息,并将主题信息绑定到nav-bar.component.ts组件
- 第一次执行站点,站点会使用定义在environment.ts中的默认值作为默认主题,当每次切换主题时,会将所选主题绑定到nav-bar.component.ts上,用来在下拉菜单中标注已选主题,并将所选主题名称保存在LocalStorage,以便下次启动站点时直接应用已选主题
- nav-bar.component.ts组件会在Navbar上的dropdown中列出所有的主题名称,并且标注所选主题,当用户点击某个主题名称时,就会触发themeSelectionChanged事件,app.component.ts接收到这个事件后,就会替换主页的link,完成主题设置
步骤
首先,根据BootswatchAPI所返回的数据结构,定义一个数据模型:
exportclassThemeDefinition{ name:string; description:string; thumbnail:string; preview:string; css:string; cssMin:string; cssCdn:string; scss:string; scssVariables:string; } exportclassThemes{ version:String; themes:ThemeDefinition[]; }
然后,创建theme.service.ts服务,用来调用BootswatchAPI:
import{Injectable}from'@angular/core'; import{HttpClient}from'@angular/common/http'; import{Observable}from'rxjs'; import{Themes}from'../models/themes'; @Injectable({ providedIn:'root' }) exportclassThemeService{ constructor(privatehttp:HttpClient){} getThemes():Observable{ returnthis.http.get ('https://bootswatch.com/api/4.json'); } }
接下来,创建Navbar组件,关键代码部分就是将主题的名称绑定到dropdown上,并根据选择的主题名称决定当前所显示的主题名称是否应该是active的。当然,dropdown的每个item还应该响应用户的点击事件:
Home (current) Link 主题 {{theme.name}}
Navbar组件的代码如下:
import{Component,OnInit,Output,EventEmitter,Input}from'@angular/core'; import{Themes}from'src/app/models/themes'; import{ThemeService}from'src/app/services/theme.service'; import{ThemeDefinition}from'src/app/models/theme-definition'; @Component({ selector:'app-nav-bar', templateUrl:'./nav-bar.component.html', styleUrls:['./nav-bar.component.css'] }) exportclassNavBarComponentimplementsOnInit{ @Input()themes:Themes; @Input()selectedTheme:string; @Output()themeSelectionChanged:EventEmitter=newEventEmitter(); constructor(privatethemeService:ThemeService){} ngOnInit(){ } onThemeItemSelected(event:any){ constselectedThemeName=event.target.text; constselectedTheme=this.themes.themes.find(t=>t.name===selectedThemeName); this.themeSelectionChanged.emit(selectedTheme); } }
在onThemeItemSelected事件处理函数中,会读取被点击dropdownitem的名称,根据该名称找到所选的主题,然后将其作为事件数据,发起themeSelectionChanged事件,然后,就是app.component.ts来处理这个事件了。在该事件处理函数中,从事件数据获取主题信息,然后调用applyTheme方法来应用主题:
import{Component,OnInit}from'@angular/core'; import{ThemeDefinition}from'./models/theme-definition'; import{Themes}from'./models/themes'; import{ThemeService}from'./services/theme.service'; import{environment}from'src/environments/environment'; import{StorageMap}from'@ngx-pwa/local-storage'; @Component({ selector:'app-root', templateUrl:'./app.component.html', styleUrls:['./app.component.css'] }) exportclassAppComponentimplementsOnInit{ title='nblogger'; themes:Themes; selectedTheme:string; constructor(privatethemeService:ThemeService, privatestorage:StorageMap){ } ngOnInit(){ this.themeService.getThemes() .subscribe(data=>{ this.themes=data; this.storage.get('app-theme-name').subscribe(name=>{ constthemeName=name?name:environment.defaultTheme; constcurrentTheme=this.themes.themes.find(t=>t.name===themeName); this.applyTheme(currentTheme); }); }); } onThemeSelectionChanged(event:ThemeDefinition){ this.applyTheme(event); } privateapplyTheme(def:ThemeDefinition):void{ this.storage.set('app-theme-name',def.name).subscribe(()=>{}); this.selectedTheme=def.name; constlinks=document.getElementsByTagName('link'); for(leti=0;i在applyTheme方法中,首先会将所选主题名称设置到LocalStorage中,以便下次打开页面的时候能够直接应用主题;然后,从当前document中找到所需的linktag,并将其href值替换为所选主题信息的cssMin链接地址(内容可以参考Bootswatch的API结果)以此完成主题替换。
当重新打开页面时,app.component.ts中的ngOnInit初始化方法会被首先调用,它会通过theme.service.ts来读取主题信息,之后判断LocalStorage中是否有已经设置好的主题。如果有,则使用该主题,否则就从environment.ts的默认值中选择主题名称进行设置。
app.component.ts所使用的template就比较简单,主体是对Navbar组件的引用,还可以加一些额外的HTML元素进行效果测试:
Heading1
Heading2
Heading3
Heading4
这是一个警告框