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

Feature/3551 clean up #524

Merged
merged 44 commits into from
Oct 7, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
44 commits
Select commit Hold shift + click to select a range
74f7e2a
Merge branch 'feature/word-smith-docs' into feature/3551-clean-up
emclaug2 Oct 4, 2022
47492d0
Go to first component instead of home
emclaug2 Oct 4, 2022
3803806
Remove console warnings
emclaug2 Oct 4, 2022
6bdc87a
Add favicon
emclaug2 Oct 4, 2022
580a24a
Make the overflow content worse
emclaug2 Oct 4, 2022
72aa5d2
Add missing api intro section
emclaug2 Oct 4, 2022
b84d699
Replace ChannelValue picture
emclaug2 Oct 4, 2022
a4e1324
Fix Drawer API docs - only show Drawer docs on Drawer page
emclaug2 Oct 4, 2022
054f37e
Wrap long input names
emclaug2 Oct 4, 2022
e5096e4
Merge branch 'feature/word-smith-docs' into feature/3551-clean-up
emclaug2 Oct 5, 2022
fd7a7ac
Merge branch 'feature/subtitle' into feature/3551-clean-up
emclaug2 Oct 5, 2022
f047ff1
Add items under drawer subheader and fix knob descriptions
emclaug2 Oct 5, 2022
e0ad8e0
Replace NavItems with Drawer Nav Items
emclaug2 Oct 5, 2022
70aca95
Add right left content options for playground
emclaug2 Oct 5, 2022
f8255bf
Adjust the playground badge offset
emclaug2 Oct 5, 2022
c45e630
Make ThreeLiner playground code update with optional props correctly
emclaug2 Oct 5, 2022
aaed46e
Change knob description to Use Avatar Image
emclaug2 Oct 5, 2022
3ead23d
Persist tab between pages
emclaug2 Oct 5, 2022
f7455bd
Merge branch 'dev' into feature/3551-clean-up
emclaug2 Oct 5, 2022
ad7dbd5
Tweak table styles, move logic to theme & adjust code highlight block…
emclaug2 Oct 6, 2022
4dd53e1
Merge branch 'dev' into feature/3551-clean-up
emclaug2 Oct 6, 2022
d44af74
Adjust code overflow examples logic
emclaug2 Oct 6, 2022
1a99a0d
Remove mat tab content under header issue on mobile
emclaug2 Oct 6, 2022
ed0b420
Run prettier
emclaug2 Oct 6, 2022
7ac524c
Lint me
emclaug2 Oct 6, 2022
6b278be
Fix color knob
emclaug2 Oct 6, 2022
da70e12
Fix number knob
emclaug2 Oct 6, 2022
dae61d4
I am lazy, try this instead
emclaug2 Oct 6, 2022
38a9ec2
Try to fork
emclaug2 Oct 6, 2022
2884d93
Adjust markdown
emclaug2 Oct 6, 2022
e62309a
Run prettier
emclaug2 Oct 6, 2022
359950b
Update open code path
emclaug2 Oct 6, 2022
58ba63d
Fix paths for dev doc code snippet
emclaug2 Oct 6, 2022
4533bc4
Run prettier
emclaug2 Oct 6, 2022
d979c1b
Match react margin
emclaug2 Oct 6, 2022
f58fcac
Fix color input
emclaug2 Oct 6, 2022
156d0ad
Fix typo
emclaug2 Oct 6, 2022
d467e0a
Patch that padding
emclaug2 Oct 7, 2022
8bac0e7
Add missing space
emclaug2 Oct 7, 2022
0286988
Code block that unit space
emclaug2 Oct 7, 2022
c8cf102
Flex 1 2 3
emclaug2 Oct 7, 2022
a5b7105
Update markdown default type look nice
emclaug2 Oct 7, 2022
4320b35
Adjust doc code blocks in default
emclaug2 Oct 7, 2022
0a800fc
Update navigation.component.html
emclaug2 Oct 7, 2022
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/firebase-hosting-merge.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
steps:
- uses: actions/checkout@v2
- run: yarn && yarn build:demo
- uses: FirebaseExtended/action-hosting-deploy@v0
- uses: emclaug2/action-hosting-deploy@main
with:
repoToken: '${{ secrets.GITHUB_TOKEN }}'
firebaseServiceAccount: '${{ secrets.FIREBASE_SERVICE_ACCOUNT_BLUI_ANGULAR_DOCS }}'
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/firebase-hosting-pull-request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ jobs:
steps:
- uses: actions/checkout@v2
- run: yarn && yarn build:demo
- uses: FirebaseExtended/action-hosting-deploy@v0
- uses: emclaug2/action-hosting-deploy@main
with:
repoToken: '${{ secrets.GITHUB_TOKEN }}'
firebaseServiceAccount: '${{ secrets.FIREBASE_SERVICE_ACCOUNT_BLUI_ANGULAR_DOCS }}'
Expand Down
Binary file added src/assets/favicon.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file removed src/docs/app.component.scss
Empty file.
3 changes: 1 addition & 2 deletions src/docs/app.module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,11 @@ import { MatIconModule } from '@angular/material/icon';
import { AppComponent } from './app.component';
import { AppRoutingModule } from './app.routing';
import { NavigationComponent } from './navigation/navigation.component';
import { HomeComponent } from './pages/home/home.component';
import { ComponentDocsModule } from './pages/component-docs/component-docs.module';
import { MatChipsModule } from '@angular/material/chips';

@NgModule({
declarations: [AppComponent, HomeComponent, NavigationComponent],
declarations: [AppComponent, NavigationComponent],
imports: [
AppRoutingModule,
BrowserAnimationsModule,
Expand Down
6 changes: 2 additions & 4 deletions src/docs/app.routing.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import { NgModule } from '@angular/core';
import { Routes, RouterModule } from '@angular/router';
import { APP_NAV_ITEMS, COMPONENT_NAV_ITEMS, DRAWER_NAV_ITEMS } from './navigation/nav-items';
import { HomeComponent } from './pages/home/home.component';
import { COMPONENT_NAV_ITEMS, DRAWER_NAV_ITEMS } from './navigation/nav-items';
import { ListItemTagDocComponent } from './pages/component-docs/components/list-item-tag/list-item-tag-doc.component';
import { DrawerNavItemDocComponent } from './pages/component-docs/components/drawer/drawer-nav-item/drawer-nav-item-doc.component';
import { DrawerNavGroupDocComponent } from './pages/component-docs/components/drawer/drawer-nav-group/drawer-nav-group-doc.component';
Expand All @@ -24,8 +23,7 @@ import { ScoreCardDocComponent } from './pages/component-docs/components/score-c
import { ToolbarMenuDocComponent } from './pages/component-docs/components/toolbar-menu/toolbar-menu-doc.component';

const routes: Routes = [
{ path: '', redirectTo: APP_NAV_ITEMS.home.route, pathMatch: 'full' },
{ path: APP_NAV_ITEMS.home.route, component: HomeComponent },
{ path: '', redirectTo: `${COMPONENT_NAV_ITEMS.appBar.route}/examples`, pathMatch: 'full' },
{ path: `${COMPONENT_NAV_ITEMS.appBar.route}/:tab`, component: AppBarDocComponent },
{ path: `${COMPONENT_NAV_ITEMS.channelValue.route}/:tab`, component: ChannelValueDocComponent },
{ path: `${COMPONENT_NAV_ITEMS.hero.route}/:tab`, component: HeroDocComponent },
Expand Down
9 changes: 6 additions & 3 deletions src/docs/md/AppBar.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# App Bar

The `<blui-app-bar>` component is a wrapper around the `<mat-toolbar>` that can be resized as the page is scrolled.
It supports three variants: `snap`, `collapsed`, and `expanded`.
It supports three variants: `'snap'`, `'collapsed'`, and `'expanded'`.

<div style="text-align:center; margin-bottom:20px">
<img width="100%" style="max-width: 600px; margin-bottom: 20px; border: 1px solid #0002;" alt="App Bar Three Liner" src="./gifs/appBarThreeLiner.gif">
Expand All @@ -25,19 +25,22 @@ imports: [ AppBarModule ]

## API

Parent element (`<blui-app-bar>`) attributes:


<div style="overflow: auto;">

| @Input | Description | Type | Required | Default |
| ------------------------ |--------------------------------------------------------| ----------------------------------------- | -------- | -------------------------------- |
| collapsedHeight | Height of the AppBar when collapsed | `number` | no | theme default |
| color | Color variant which is passed to the `<mat-toolbar>` | `'primary'` \| `'accent'` \| `'warn'` | no | 'primary' |
| color | Color variant which is passed to the `<mat-toolbar>` | `'primary'` \| `'accent'` \| `'warn'` | no | `'primary'` |
| expandedHeight | Height of the AppBar when expanded | `number` | no | 200 |
| collapsedChange | Event emitter for when the appbar opens or closes | `EventEmitter<boolean>` | no | |
| scrollContainerElement | Scrollable element which dynamic app bar responds to | `Element` | no | |
| scrollContainerClassName | Class name, index number of scrollable element | `{ name: string, index: number }` | no | |
| scrollContainerId | Id of the scrollable element | `string` | no | |
| scrollThreshold | Distance in pixels to scroll before collapsing toolbar | `number` | no | expandedHeight - collapsedHeight |
| variant | Behavior of the App Bar | `'expanded'` \| `'collapsed'` \| `'snap'` | no | 'collapsed' |
| variant | Behavior of the App Bar | `'expanded'` \| `'collapsed'` \| `'snap'` | no | `'collapsed'` |

</div>

Expand Down
18 changes: 8 additions & 10 deletions src/docs/md/ChannelValue.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,7 @@ The `<blui-channel-value>` component is used to display a channel value (and uni
Icons are passed in as a child element of the `<blui-channel-value>` component.

<div style="text-align:center; margin-bottom:20px">
<img width="100%" style="max-width: 600px" alt="Channel Value in Hero" src="./images/heroes.png">
<hr/>
<img width="100%" style="max-width: 600px" alt="Channel Value in a list item" src="./images/channelValue.png">
<img width="100%" style="max-width: 400px" alt="Channel Value in a list item" src="./images/channelValue.png">
</div>

## Usage
Expand All @@ -31,16 +29,16 @@ Parent element (`<blui-channel-value>`) attributes:

<div style="overflow: auto;">

| @Input | Description | Type | Required | Default |
|------------| ---------------------------------------------- | -------------------------------- | -------- | ------ |
| prefix | If true, shows units before the value | `boolean` | no | false |
| units | Text to display for the units | `string` | no | |
| unitSpace* | Show/Hide spacing between the value and units | `'auto'` \| `'hide'` \| `'show'` | no | 'auto' |
| value | Text to display for the value | `string` \| `number` | yes | |
| @Input | Description | Type | Required | Default |
|------------| ---------------------------------------------- | -------------------------------- | -------- |----------|
| prefix | If true, shows units before the value | `boolean` | no | false |
| units | Text to display for the units | `string` | no | |
| unitSpace* | Show/Hide spacing between the value and units | `'auto'` \| `'hide'` \| `'show'` | no | `'auto'` |
| value | Text to display for the value | `string` \| `number` | yes | |

</div>

> *Setting unitSpace to 'auto' will show a space for all units except for '%', '℉', '°C', and '°'. When prefix is true, the space will be shown for all units except for '$'.
> *Setting `unitSpace` to 'auto' will show a space for all units except for '%', '℉', '°C', and '°'. When prefix is true, the space will be shown for all units except for '$'.

The following child element is projected into `<blui-channel-value>`:

Expand Down