transit-templates
v0.0.1
Published
This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 17.3.0.
Readme
TransitTemplates
This library was generated with Angular CLI version 17.3.0.
As of 2024-08-19, only Theme A is ready for use, with Themes B to D following up soon.
Each theme can be imported as an entire module, or you can import each element of the theme alone.
Please install @ng-bootstrap/ng-bootstrap to be able to use this package.
Theme A
This theme arrives with four preset components:
- Navigation Bar (Navbar)
- Hero Section
- Affiliate Authorities
- Footer Section
Each component has its inputs to allow setting up for the use case needed:
- Navigation Bar:
- navbarLogo (string): Path to the image asset you want to show as the logo.
- ministryName (string): The name of the Ministry that will be represented with your project.
- navbarItems (interface NavbarItem): The menu to show in the navigation bar.
- Hero Section:
- heroImage (string): Path to the image asset to show in the top banner of the Hero Section.
- imageOnly (boolean): Whether to show just the images of the bottom Carousel of the Hero Section or actually show them as full News links.
- newsSlides (interface NewsSlide): The actual content to show in the Carousel.
- Affiliate Authorities:
- links (interface Link): The authorities within the Ministry.
- Footer Section:
- linkLists (interface LinkList): The links to show in the Footer section.
- footerLogo (string): The image asset to show as the logo in the Footer.
- companyName (string): The name of your company that developed the Project that includes this Library.
- copyrightYear (string): The year in which your Project was developed. It is preferred to provide this input to mark the start of the Project's development.
Interfaces:
- NavbarItem:
- itemTitle: string
- isDropdown: boolean
- itemLink: string (optional)
- dropdownItems: array of Objects (optional):
- dropdownItemName: string
- dropdownItemLink: string (optional)
- NewsSlide:
- image: string
- eyecatch: string
- type: string
- colour: string
- textColour: string
- Link:
- title: string
- description: string (optional, unused for now)
- routingLink: string (optional for now)
- LinkList:
- listTitle: string
- listItems: array of Objects:
- itemTitle: string
- itemLink: string (optional)
