@fluentui-react-native/framework-base
v0.6.1
Published
Base types and utilities fluentui-react-native frameworks
Downloads
17,918
Keywords
Readme
@fluentui-react-native/framework-base
This package provides core implementations and types to support both the legacy and current frameworks.
The functionality in these packages is now exposed as part of this package.
Component Patterns
The shared rendering patterns and JSX handlers are centralized in this package. See the
component authoring guide for how to choose and
combine directComponent, phasedComponent, and slots.
Type Helpers
This package provides several TypeScript utility types:
PropsOf<TComponent>- Extract props from a React component typePropsWithRefOf<TComponent>- Extract props, including a supported ref, from a React component typePropsChildren<TProps>- Extract the children entry from a props typePropsWithoutChildren<TProps>/PartialWithoutChildren<TProps>- Remove children while preserving unionsFunctionComponent<TProps>- A function component type without the children handling complications of React.FCDirectComponent<TProps>- A function component marked for direct renderingPhasedComponent<TProps>- A component with two-phase rendering supportPhasedRender<TProps>- The render signature for phased components (phase one returns the phase two renderer)SlotComponent<TProps>- Slot component type used in the composition frameworkPropsTransform<TPropsIn, TPropsOut>- A transform that maps one set of props to anotherComponentPropsTransform<TComponent>- A transform for the resolved props of a component typeSlotOptions<TComponent>- Default props, transform, and optional-slot rendering behaviorSimplify<T>,OuterPartial<T>, andPartialExcept<T, K>- Helpers for producing readable partial object typesMergeCoreOptions- Options accepted byimmutableMergeCoreValueFactory<T>- Factory signature accepted by memo cache functions
JSX Runtime
This package exports a custom JSX runtime at @fluentui-react-native/framework-base/jsx-runtime. Use it in your component files by adding this pragma as the first line of the file:
/** @jsxImportSource @fluentui-react-native/framework-base */The custom runtime enables automatic element flattening for direct and phased components. Any package using this pragma must include @fluentui-react-native/framework-base in its devDependencies.
Note: This is the current pattern and replaces the legacy
/** @jsx withSlots */directive (which required importingwithSlotsexplicitly). The exportedwithSlotshelper remains available only for the classic runtime used by deprecated framework code.
