ncn-utils

Index

Namespaces

ReactUtils

Variables

Portal

Functions

Variables

Const Portal

Portal: React.FC<PortalProps> = ...

Higher order component that manages creation and teardown of root elements and SSR to create a portal for the children that's passed into it.

remarks

The component prevents being rendered during SSR inherently, so there's no need to make preventions for this.

remarks

No automation testing.

param id

(Optional) Pass an id to an existing element to attach to that element. An element with a unique ID will be generated if one isn't provided.

param children

Children passed to the component.

Functions

NoSsr

NoSsr(children: { children: ReactNode }): Element

- Defined in components/NoSsr/NoSsr.tsx:12
Higher order component that wraps components that should be ignored from SSR.

remarks
No automated testing due to difficulty in testing this usecase. Manually tested instead. Refer to this to implement future automated testing: https://github.com/mui/material-ui/blob/4729495c5354f2880a39352a855ff3bbc8a0103f/packages/mui-base/src/NoSsr/NoSsr.test.js

Parameters
- children: { children: ReactNode }
  
  Any components that are wrapped within
  - children: ReactNode
Returns Element

ccl

ccl(...args: (string | false)[]): string

- Defined in utils/ccl/ccl.ts:9
Combines an array of strings after filtering out falsey values to produce a single string representing a classlist.

Parameters
- Rest ...args: (string | false)[]
  
  Array of strings each representing a classname. Falsey values will be filtered out.
Returns string
Single string representing a classname

useKeyboard

useKeyboard(keys: KeyDownCondition[]): void

- Defined in hooks/useKeyboard/useKeyboard.ts:22
Custom hook to handle keyboard pressdown events.
example
Handles an event which focuses an element by id when ctrl+f is pressed:
```
useKeyboard( [{
     key: "f", mods: ["ctrl"], action: ( e ) => {
         e.preventDefault();
         document.querySelector( "#filter-searchbar" ).focus();
     }
}] );
```
Parameters
- keys: KeyDownCondition[]
Returns void

Generated using TypeDoc