Skip to content

fix(xl-pdf-exporter): Keep image aspect ratio, page fit fixes #2887

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Wqrld wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(xl-pdf-exporter): Keep image aspect ratio, page fit fixes #2887

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions packages/xl-pdf-exporter/src/pdf/__snapshots__/example.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -650,12 +650,17 @@
<IMAGE
src={[object Blob]}
style={{
maxHeight: 722.99,
maxWidth: '100%',
objectFit: 'contain',
objectPosition: '0% 0%',
width: undefined
}}
/>
<TEXT
style={{
fontSize: 9.600000000000001,
maxWidth: '100%',
width: undefined
}}
>
Expand All @@ -678,6 +683,10 @@
<IMAGE
src={[object Blob]}
style={{
maxHeight: 737.39,
maxWidth: '100%',
objectFit: 'contain',
objectPosition: '100% 0%',
width: 150
}}
/>
Expand Down Expand Up @@ -719,6 +728,7 @@
<TEXT
style={{
fontSize: 9.600000000000001,
maxWidth: '100%',
width: undefined
}}
>
Expand Down Expand Up @@ -762,6 +772,7 @@
<TEXT
style={{
fontSize: 9.600000000000001,
maxWidth: '100%',
width: undefined
}}
>
Expand Down Expand Up @@ -818,6 +829,7 @@
<TEXT
style={{
fontSize: 9.600000000000001,
maxWidth: '100%',
width: undefined
}}
>
Expand Down
87 changes: 87 additions & 0 deletions packages/xl-pdf-exporter/src/pdf/__snapshots__/exampleWithAlignedImages.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
<DOCUMENT>
<PAGE
dpi={100}
size="A4"
style={{
fontFamily: 'Inter',
fontSize: 12,
lineHeight: 1.5,
paddingBottom: 65,
paddingHorizontal: 35,
paddingTop: 35
}}
>
<React.Fragment key=".1:$">
<VIEW
style={{
alignItems: undefined,
backgroundColor: undefined,
color: undefined,
paddingVertical: 2.25,
textAlign: 'left'
}}
>
<VIEW>
<IMAGE
src={[object Blob]}
style={{
maxHeight: 737.39,
maxWidth: '100%',
objectFit: 'contain',
objectPosition: '0% 0%',
width: 1500
}}
/>
</VIEW>
</VIEW>
</React.Fragment>
<React.Fragment key=".1:$">
<VIEW
style={{
alignItems: 'center',
backgroundColor: undefined,
color: undefined,
paddingVertical: 2.25,
textAlign: 'center'
}}
>
<VIEW>
<IMAGE
src={[object Blob]}
style={{
maxHeight: 737.39,
maxWidth: '100%',
objectFit: 'contain',
objectPosition: '50% 0%',
width: 1500
}}
/>
</VIEW>
</VIEW>
</React.Fragment>
<React.Fragment key=".1:$">
<VIEW
style={{
alignItems: 'flex-end',
backgroundColor: undefined,
color: undefined,
paddingVertical: 2.25,
textAlign: 'right'
}}
>
<VIEW>
<IMAGE
src={[object Blob]}
style={{
maxHeight: 737.39,
maxWidth: '100%',
objectFit: 'contain',
objectPosition: '100% 0%',
width: 1500
}}
/>
</VIEW>
</VIEW>
</React.Fragment>
</PAGE>
</DOCUMENT>
12 changes: 12 additions & 0 deletions packages/xl-pdf-exporter/src/pdf/__snapshots__/exampleWithHeaderAndFooter.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -658,12 +658,17 @@
<IMAGE
src={[object Blob]}
style={{
maxHeight: 722.99,
maxWidth: '100%',
objectFit: 'contain',
objectPosition: '0% 0%',
width: undefined
}}
/>
<TEXT
style={{
fontSize: 9.600000000000001,
maxWidth: '100%',
width: undefined
}}
>
Expand All @@ -686,6 +691,10 @@
<IMAGE
src={[object Blob]}
style={{
maxHeight: 737.39,
maxWidth: '100%',
objectFit: 'contain',
objectPosition: '100% 0%',
width: 150
}}
/>
Expand Down Expand Up @@ -727,6 +736,7 @@
<TEXT
style={{
fontSize: 9.600000000000001,
maxWidth: '100%',
width: undefined
}}
>
Expand Down Expand Up @@ -770,6 +780,7 @@
<TEXT
style={{
fontSize: 9.600000000000001,
maxWidth: '100%',
width: undefined
}}
>
Expand Down Expand Up @@ -826,6 +837,7 @@
<TEXT
style={{
fontSize: 9.600000000000001,
maxWidth: '100%',
width: undefined
}}
>
Expand Down
68 changes: 59 additions & 9 deletions packages/xl-pdf-exporter/src/pdf/defaultSchema/blocks.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,16 @@ import {
ListItem,
} from "../util/listItem.js";
import { Table } from "../util/table/Table.js";
import { Style } from "../types.js";
import {
BLOCK_VERTICAL_PADDING,
PAGE_HEIGHT,
type PDFExporter,
} from "../pdfExporter.js";

const PIXELS_PER_POINT = 0.75;
const FONT_SIZE = 16;
const CAPTION_FONT_SIZE = FONT_SIZE * 0.8 * PIXELS_PER_POINT;

export const pdfBlockMappingForDefaultSchema: BlockMapping<
DefaultBlockSchema & {
Expand Down Expand Up @@ -237,11 +244,7 @@ export const pdfBlockMappingForDefaultSchema: BlockMapping<
<View wrap={false} key={"image" + block.id}>
<Image
src={await t.resolveFile(block.props.url)}
style={{
width: block.props.previewWidth
? block.props.previewWidth * PIXELS_PER_POINT
: undefined,
}}
style={imageStyle(block.props, t)}
/>
{caption(block.props, t)}
</View>
Expand Down Expand Up @@ -277,6 +280,54 @@ function file(
);
}

function previewWidthToPoints(
props: Partial<DefaultProps & { previewWidth: number }>,
): number | undefined {
return props.previewWidth ? props.previewWidth * PIXELS_PER_POINT : undefined;
}

// Style values can also be strings ("10pt", "5%"); the page styles set in
// `PDFExporter` are plain numbers, so treat anything else as the fallback.
function points(value: number | string | undefined, fallback: number): number {
return typeof value === "number" ? value : fallback;
}

function imageStyle(
props: Partial<DefaultProps & { caption: string; previewWidth: number }>,
exporter: any,
): Style {
const page: Style =
(exporter as PDFExporter<any, any, any>).styles?.page ?? {};
return {
width: previewWidthToPoints(props),
maxWidth: "100%",
// Images can't break across pages, so cap the box to the usable page
// height (accounting for the padding `transformBlocks` adds around every
// block); a taller box would spill an empty page after the bitmap. If
// there's a caption, also reserve one line for it. Known limitations:
// captions long enough to wrap, and headers passed to
// `toReactPDFDocument` (which take flow height on every page), can still
// make the unbreakable image group spill.
maxHeight:
PAGE_HEIGHT -
points(page.paddingTop, 0) -
points(page.paddingBottom, 0) -
2 * BLOCK_VERTICAL_PADDING -
(props.caption ? CAPTION_FONT_SIZE * points(page.lineHeight, 1.5) : 0),
// `contain` leaves slack inside the box when it's clamped by `maxWidth`
// or `maxHeight`, so pin the bitmap to the block's alignment edge. The
// box itself is aligned by `blocknoteDefaultPropsToReactPDFStyle` on the
// wrapper.
objectFit: "contain",
objectPosition:
props.textAlignment === "right"
? "100% 0%"
: props.textAlignment === "center"
? "50% 0%"
: "0% 0%",
};
}

function caption(
props: Partial<DefaultProps & { caption: string; previewWidth: number }>,
_exporter: any,
Expand All @@ -288,10 +339,9 @@ function caption(
<Text
key={"caption" + props.caption}
style={{
width: props.previewWidth
? props.previewWidth * PIXELS_PER_POINT
: undefined,
fontSize: FONT_SIZE * 0.8 * PIXELS_PER_POINT,
width: previewWidthToPoints(props),
maxWidth: "100%",
fontSize: CAPTION_FONT_SIZE,
}}
>
{props.caption}
Expand Down
Loading