@react-pdf/stylesheet 5.2.1 → 6.0.0

package/lib/index.d.ts

@@ -0,0 +1,284 @@
+type Container = {
+    width: number;
+    height: number;
+    dpi?: number;
+    remBase?: number;
+    orientation?: 'landscape' | 'portrait';
+};
+type BorderStyleValue = 'dashed' | 'dotted' | 'solid';
+type BorderShorthandStyle = {
+    border?: number | string;
+    borderTop?: number | string;
+    borderRight?: number | string;
+    borderBottom?: number | string;
+    borderLeft?: number | string;
+    borderColor?: string;
+    borderRadius?: number | string;
+    borderStyle?: BorderStyleValue;
+    borderWidth?: number | string;
+};
+type BorderExpandedStyle = {
+    borderTopColor?: string;
+    borderTopStyle?: BorderStyleValue;
+    borderTopWidth?: number | string;
+    borderRightColor?: string;
+    borderRightStyle?: BorderStyleValue;
+    borderRightWidth?: number | string;
+    borderBottomColor?: string;
+    borderBottomStyle?: BorderStyleValue;
+    borderBottomWidth?: number | string;
+    borderLeftColor?: string;
+    borderLeftStyle?: BorderStyleValue;
+    borderLeftWidth?: number | string;
+    borderTopLeftRadius?: number | string;
+    borderTopRightRadius?: number | string;
+    borderBottomRightRadius?: number | string;
+    borderBottomLeftRadius?: number | string;
+};
+type BorderSafeStyle = BorderExpandedStyle & {
+    borderTopWidth?: number;
+    borderRightWidth?: number;
+    borderBottomWidth?: number;
+    borderLeftWidth?: number;
+    borderTopLeftRadius?: number;
+    borderTopRightRadius?: number;
+    borderBottomRightRadius?: number;
+    borderBottomLeftRadius?: number;
+};
+type BorderStyle = BorderShorthandStyle & BorderExpandedStyle;
+type FlexboxShorthandStyle = {
+    flex?: number | string;
+};
+type AlignContent = 'flex-start' | 'flex-end' | 'center' | 'stretch' | 'space-between' | 'space-around' | 'space-evenly';
+type AlignItems = 'flex-start' | 'flex-end' | 'center' | 'stretch' | 'baseline';
+type AlignSelf = 'auto' | 'flex-start' | 'flex-end' | 'center' | 'baseline' | 'stretch';
+type FlexDirection = 'row' | 'row-reverse' | 'column' | 'column-reverse';
+type FlexWrap = 'nowrap' | 'wrap' | 'wrap-reverse';
+type JustifyContent = 'flex-start' | 'flex-end' | 'center' | 'space-around' | 'space-between' | 'space-evenly';
+type JustifySelf = string;
+type FlexboxExpandedStyle = {
+    alignContent?: AlignContent;
+    alignItems?: AlignItems;
+    alignSelf?: AlignSelf;
+    flexDirection?: FlexDirection;
+    flexWrap?: FlexWrap;
+    flexFlow?: number | string;
+    flexGrow?: number | string;
+    flexShrink?: number | string;
+    flexBasis?: number | string;
+    justifySelf?: JustifySelf;
+    justifyContent?: JustifyContent;
+};
+type FlexboxSafeStyle = FlexboxExpandedStyle & {
+    flexGrow?: number;
+    flexShrink?: number;
+};
+type FlexboxStyle = FlexboxShorthandStyle & FlexboxExpandedStyle;
+type GapShorthandStyle = {
+    gap?: number | string;
+};
+type GapExpandedStyle = {
+    rowGap?: number | string;
+    columnGap?: number | string;
+};
+type GapSafeStyle = {
+    rowGap?: number;
+    columnGap?: number;
+};
+type GapStyle = GapShorthandStyle & GapExpandedStyle;
+type PositionShorthandStyle = {
+    objectPosition?: number | string;
+};
+type PositionExpandedStyle = {
+    objectPositionX?: number | string;
+    objectPositionY?: number | string;
+    objectFit?: string;
+};
+type PositionSafeStyle = PositionExpandedStyle & {
+    objectPositionX?: number;
+    objectPositionY?: number;
+};
+type PositioningStyle = PositionShorthandStyle & PositionExpandedStyle;
+type TransformShorthandStyle = {
+    transformOrigin?: number | string;
+};
+type TransformExpandedStyle = {
+    transformOriginX?: number | string;
+    transformOriginY?: number | string;
+    transform?: string;
+};
+type TransformSafeStyle = TransformExpandedStyle & {
+    transformOriginX?: number;
+    transformOriginY?: number;
+};
+type TransformStyle = TransformShorthandStyle & TransformExpandedStyle;
+type Display = 'flex' | 'none';
+type Position = 'absolute' | 'relative' | 'static';
+type LayoutStyle = {
+    aspectRatio?: number | string;
+    bottom?: number | string;
+    display?: Display;
+    left?: number | string;
+    position?: Position;
+    right?: number | string;
+    top?: number | string;
+    overflow?: 'hidden';
+    zIndex?: number | string;
+};
+type LayoutExpandedStyle = LayoutStyle;
+type LayoutSafeStyle = LayoutExpandedStyle & {
+    aspectRatio?: number;
+    bottom?: number;
+    left?: number;
+    right?: number;
+    top?: number;
+    zIndex?: number;
+};
+type DimensionStyle = {
+    height?: number | string;
+    maxHeight?: number | string;
+    maxWidth?: number | string;
+    minHeight?: number | string;
+    minWidth?: number | string;
+    width?: number | string;
+};
+type DimensionExpandedStyle = DimensionStyle;
+type DimensionSafeStyle = DimensionExpandedStyle & {
+    height?: number;
+    maxHeight?: number;
+    maxWidth?: number;
+    minHeight?: number;
+    minWidth?: number;
+    width?: number;
+};
+type ColorStyle = {
+    backgroundColor?: string;
+    color?: string;
+    opacity?: number | string;
+};
+type ColorSafeStyle = {
+    backgroundColor?: string;
+    color?: string;
+    opacity?: number;
+};
+type FontStyle = 'normal' | 'italic' | 'oblique';
+type FontWeight = string | number | 'thin' | 'hairline' | 'ultralight' | 'extralight' | 'light' | 'normal' | 'medium' | 'semibold' | 'demibold' | 'bold' | 'ultrabold' | 'extrabold' | 'heavy' | 'black';
+type TextAlign = 'left' | 'right' | 'center' | 'justify';
+type TextDecoration = 'line-through' | 'underline' | 'none' | 'line-through underline' | 'underline line-through';
+type TextDecorationStyle = 'dashed' | 'dotted' | 'solid' | string;
+type TextTransform = 'capitalize' | 'lowercase' | 'uppercase' | 'none';
+type VerticalAlign = 'sub' | 'super';
+type TextStyle = {
+    fontSize?: number | string;
+    fontFamily?: string | string[];
+    fontStyle?: FontStyle;
+    fontWeight?: FontWeight;
+    letterSpacing?: number | string;
+    lineHeight?: number | string;
+    maxLines?: number;
+    textAlign?: TextAlign;
+    textDecoration?: TextDecoration;
+    textDecorationColor?: string;
+    textDecorationStyle?: TextDecorationStyle;
+    textIndent?: any;
+    textOverflow?: 'ellipsis';
+    textTransform?: TextTransform;
+    verticalAlign?: VerticalAlign;
+};
+type TextExpandedStyle = TextStyle;
+type TextSafeStyle = TextExpandedStyle & {
+    fontSize?: number;
+    fontWeight?: number;
+    letterSpacing?: number;
+    lineHeight?: number;
+};
+type MarginShorthandStyle = {
+    margin?: number | string;
+    marginHorizontal?: number | string;
+    marginVertical?: number | string;
+};
+type MarginExpandedStyle = {
+    marginTop?: number | string;
+    marginRight?: number | string;
+    marginBottom?: number | string;
+    marginLeft?: number | string;
+};
+type MarginSafeStyle = MarginExpandedStyle & {
+    marginTop?: number;
+    marginRight?: number;
+    marginBottom?: number;
+    marginLeft?: number;
+};
+type MarginStyle = MarginShorthandStyle & MarginExpandedStyle;
+type PaddingShorthandStyle = {
+    padding?: number | string;
+    paddingHorizontal?: number | string;
+    paddingVertical?: number | string;
+};
+type PaddingExpandedStyle = {
+    paddingTop?: number | string;
+    paddingRight?: number | string;
+    paddingBottom?: number | string;
+    paddingLeft?: number | string;
+};
+type PaddingSafeStyle = PaddingExpandedStyle & {
+    paddingTop?: number;
+    paddingRight?: number;
+    paddingBottom?: number;
+    paddingLeft?: number;
+};
+type PaddingStyle = PaddingShorthandStyle & PaddingExpandedStyle;
+interface SvgStyle {
+    fill?: string;
+    stroke?: string;
+    strokeDasharray?: string;
+    strokeWidth?: string | number;
+    fillOpacity?: string | number;
+    fillRule?: 'nonzero' | 'evenodd';
+    strokeOpacity?: string | number;
+    textAnchor?: 'start' | 'middle' | 'end';
+    strokeLinecap?: 'butt' | 'round' | 'square';
+    strokeLinejoin?: 'butt' | 'round' | 'square';
+    visibility?: 'visible' | 'hidden' | 'collapse';
+    clipPath?: string;
+    dominantBaseline?: 'auto' | 'middle' | 'central' | 'hanging' | 'mathematical' | 'text-after-edge' | 'text-before-edge';
+}
+type SvgSafeStyle = SvgStyle & {
+    strokeWidth?: number;
+    fillOpacity?: number;
+    strokeOpacity?: number;
+};
+type BaseStyle = BorderStyle & ColorStyle & DimensionStyle & FlexboxStyle & GapStyle & LayoutStyle & MarginStyle & PaddingStyle & PositioningStyle & TextStyle & TransformStyle & SvgStyle;
+type MediaQueryStyle = {
+    [key in `@media${string}`]: BaseStyle;
+};
+type Style = BaseStyle & MediaQueryStyle;
+type SafeStyle = BorderSafeStyle & ColorSafeStyle & DimensionSafeStyle & FlexboxSafeStyle & GapSafeStyle & LayoutSafeStyle & MarginSafeStyle & PaddingSafeStyle & PositionSafeStyle & TextSafeStyle & TransformSafeStyle & SvgSafeStyle;
+
+/**
+ * Transform given color to hexa
+ *
+ * @param value - Styles value
+ * @returns Transformed value
+ */
+declare const transformColor: (value: string) => string;
+
+/**
+ * Flattens an array of style objects, into one aggregated style object.
+ *
+ * @param styles - Style or style array
+ * @returns Flattened style object
+ */
+declare const flatten: (value: Style | Style[], ...args: any[]) => Style;
+
+type StyleParam = Style | null | undefined;
+/**
+ * Resolves styles
+ *
+ * @param container
+ * @param style - Style
+ * @returns Resolved style
+ */
+declare const resolveStyles: (container: Container, style: StyleParam | StyleParam[]) => SafeStyle;
+
+export { type SafeStyle, type Style, resolveStyles as default, flatten, transformColor };