Commit 0fdd15b7 authored by Shane Eckenrode's avatar Shane Eckenrode

Update readme

parent 377038a8
Pipeline #84940 passed with stages
in 3 minutes and 59 seconds
# utils-responsive
# Responsive Utils
This library was generated with [Nx](https://nx.dev).
## ResponsiveService
## Running unit tests
Injectable singleton service responsible for tracking changes to screen sizes. To use, simply inject the service into the constructor.
Run `nx test utils-responsive` to execute the unit tests.
```typescript
import { ResponsiveService } from '@psu/utils/responsive';
constructor(public responsiveService: ResponsiveService) {}
```
### Public API
```typescript
// Reactive context
public currentScreenSize$: Observable<ScreenSize>;
public isMobile$: Observable<boolean>;
public isTabletSmall$: Observable<boolean>;
public isTabletLarge$: Observable<boolean>;
public isDesktop$: Observable<boolean>;
// Static context
public currentScreenSize: ScreenSize;
public isMobile: boolean;
public isTabletSmall: boolean;
public isTabletLarge: boolean;
public isDesktop: boolean;
```
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment