Skip to content
This repository was archived by the owner on Jan 6, 2025. It is now read-only.

Commit f1b3589

Browse files
CaerusKaruThomasBurleson
authored andcommitted
docs: update src docs to be in line with Uncyclo updates
1 parent cca27c0 commit f1b3589

File tree

5 files changed

+57
-180
lines changed

5 files changed

+57
-180
lines changed

docs/documentation/CI-Tools.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
### Continuous Integration (CI) Tools
2+
3+
4+
Due to overuse of the Angular core license and loads on the Angular BrowserStack license, Flex-Layout has switched to an independent license of BrowserStack. This was will facilitate more stable CI testing [with PRs and builds] and avoid the excessive *timeouts* occurring with the Angular core license.
5+
6+
> This is a temporary solution only; started on March 9, 2018.
7+
8+
##### Building with Bazel
9+
10+
As part of efforts to migrate to building with Bazel, Flex-Layout is also migrating to CircleCI as part of the library's continuous integration toolset. This will work in tandem with Travis CI to handle all of our builds during the migration period.
11+
12+
More updates on our build process will be posted here as they're available.

docs/documentation/Custom-Breakpoints.md

Lines changed: 0 additions & 179 deletions
This file was deleted.
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
`@angular/flex-layout` now supports server-side rendering (SSR).
2+
3+
Developers should see the Universal Demo app source for details:
4+
5+
* [main.server.ts](https://github.com/angular/flex-layout/blob/95a6e83bc9ce67a218d0b14e994ad41229b3ee75/src/apps/universal-app/src/main.server.ts)
6+
* [app.server.module.ts](https://github.com/angular/flex-layout/blob/95a6e83bc9ce67a218d0b14e994ad41229b3ee75/src/apps/universal-app/src/app/app.server.module.ts)
7+
8+
> The `app.server.module` uses the *FlexLayoutServerModule* (instead of the FlexLayoutModule).
9+
10+
The *FlexLayoutServerModule* entrypoint consolidates the logic for running Flex Layout on the server. Because SSR usings uses Node.js APIs, the FlexLayoutServerModule must be segmented into a server-only bundle.
11+
12+
> This also helps avoid including server code in the browser bundle.
13+
14+
The `FlexLayoutServerModule`, can be imported into a server modulefile, e.g. `app.server.module.ts` as follows:
15+
16+
```typescript
17+
import {NgModule} from '@angular/core';
18+
import {FlexLayoutServerModule} from '@angular/flex-layout/server';
19+
20+
@NgModule(({
21+
imports: [
22+
... other imports here
23+
FlexLayoutServerModule,
24+
]
25+
}))
26+
export class AppServerModule {}
27+
```
28+
29+
This module - in addition to handling all of the style processing/rendering before the Angular app is
30+
bootstrapped on the server - also substitutes the version of `MatchMedia` with a server-compatible
31+
implementation called `ServerMatchMedia`.

docs/documentation/_Sidebar.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
* [Static API](https://github.com/angular/flex-layout/wiki/Declarative-API-Overview)
99
* [Responsive API](https://github.com/angular/flex-layout/wiki/Responsive-API)
1010
* [API Documentation](https://github.com/angular/flex-layout/wiki/API-Documentation)
11-
* [Custom Breakpoints](https://github.com/angular/flex-layout/wiki/Custom-Breakpoints)
11+
* [Custom Breakpoints](https://github.com/angular/flex-layout/wiki/Breakpoints)
1212
* [Best Performance](https://github.com/angular/flex-layout/wiki/Best-Performance)
1313
* Demos
1414
* [Live Online](https://tburleson-layouts-demos.firebaseapp.com/)

docs/documentation/fxLayout-API.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,19 @@ container:
3434
| `column` | `flex-direction: column` |
3535
| `column-reverse` | `flex-direction: column-reverse` |
3636

37+
38+
### fxLayout + wrap
39+
40+
By default, flex items will not wrap in their container. Formerly published as distinct directive, `fxLayoutWrap` was deprecated in favor of simply adding the **wrap** parameter as a secondary option to the `fxLayout` directive.
41+
42+
```html
43+
<div fxLayout="row wrap">
44+
<div>1. One</div> <div>2. Two</div> <div>3. Three</div> <div>4. Four</div>
45+
</div>
46+
```
47+
48+
Note: when using `wrap`, developers must **first** specify the layout direction.
49+
3750
### fxLayout Side-Effects
3851

3952
Changes to the fxLayout value will cause the following directives to update and modify their element stylings:

0 commit comments

Comments
 (0)