'use strict'; const { visit, visitSkip, querySelector, detachNodeFromParent, } = require('../lib/xast.js'); const { collectStylesheet, computeStyle } = require('../lib/style.js'); const { parsePathData } = require('../lib/path.js'); exports.name = 'removeHiddenElems'; exports.description = 'removes hidden elements (zero sized, with absent attributes)'; /** * Remove hidden elements with disabled rendering: * - display="none" * - opacity="0" * - circle with zero radius * - ellipse with zero x-axis or y-axis radius * - rectangle with zero width or height * - pattern with zero width or height * - image with zero width or height * - path with empty data * - polyline with empty points * - polygon with empty points * * @author Kir Belevich * * @type {import('./plugins-types').Plugin<'removeHiddenElems'>} */ exports.fn = (root, params) => { const { isHidden = true, displayNone = true, opacity0 = true, circleR0 = true, ellipseRX0 = true, ellipseRY0 = true, rectWidth0 = true, rectHeight0 = true, patternWidth0 = true, patternHeight0 = true, imageWidth0 = true, imageHeight0 = true, pathEmptyD = true, polylineEmptyPoints = true, polygonEmptyPoints = true, } = params; const stylesheet = collectStylesheet(root); visit(root, { element: { enter: (node, parentNode) => { // transparent element inside clipPath still affect clipped elements if (node.name === 'clipPath') { return visitSkip; } const computedStyle = computeStyle(stylesheet, node); // opacity="0" // // https://www.w3.org/TR/SVG11/masking.html#ObjectAndGroupOpacityProperties if ( opacity0 && computedStyle.opacity && computedStyle.opacity.type === 'static' && computedStyle.opacity.value === '0' ) { detachNodeFromParent(node, parentNode); return; } }, }, }); return { element: { enter: (node, parentNode) => { // Removes hidden elements // https://www.w3schools.com/cssref/pr_class_visibility.asp const computedStyle = computeStyle(stylesheet, node); if ( isHidden && computedStyle.visibility && computedStyle.visibility.type === 'static' && computedStyle.visibility.value === 'hidden' && // keep if any descendant enables visibility querySelector(node, '[visibility=visible]') == null ) { detachNodeFromParent(node, parentNode); return; } // display="none" // // https://www.w3.org/TR/SVG11/painting.html#DisplayProperty // "A value of display: none indicates that the given element // and its children shall not be rendered directly" if ( displayNone && computedStyle.display && computedStyle.display.type === 'static' && computedStyle.display.value === 'none' && // markers with display: none still rendered node.name !== 'marker' ) { detachNodeFromParent(node, parentNode); return; } // Circles with zero radius // // https://www.w3.org/TR/SVG11/shapes.html#CircleElementRAttribute // "A value of zero disables rendering of the element" // // if ( circleR0 && node.name === 'circle' && node.children.length === 0 && node.attributes.r === '0' ) { detachNodeFromParent(node, parentNode); return; } // Ellipse with zero x-axis radius // // https://www.w3.org/TR/SVG11/shapes.html#EllipseElementRXAttribute // "A value of zero disables rendering of the element" // // if ( ellipseRX0 && node.name === 'ellipse' && node.children.length === 0 && node.attributes.rx === '0' ) { detachNodeFromParent(node, parentNode); return; } // Ellipse with zero y-axis radius // // https://www.w3.org/TR/SVG11/shapes.html#EllipseElementRYAttribute // "A value of zero disables rendering of the element" // // if ( ellipseRY0 && node.name === 'ellipse' && node.children.length === 0 && node.attributes.ry === '0' ) { detachNodeFromParent(node, parentNode); return; } // Rectangle with zero width // // https://www.w3.org/TR/SVG11/shapes.html#RectElementWidthAttribute // "A value of zero disables rendering of the element" // // if ( rectWidth0 && node.name === 'rect' && node.children.length === 0 && node.attributes.width === '0' ) { detachNodeFromParent(node, parentNode); return; } // Rectangle with zero height // // https://www.w3.org/TR/SVG11/shapes.html#RectElementHeightAttribute // "A value of zero disables rendering of the element" // // if ( rectHeight0 && rectWidth0 && node.name === 'rect' && node.children.length === 0 && node.attributes.height === '0' ) { detachNodeFromParent(node, parentNode); return; } // Pattern with zero width // // https://www.w3.org/TR/SVG11/pservers.html#PatternElementWidthAttribute // "A value of zero disables rendering of the element (i.e., no paint is applied)" // // if ( patternWidth0 && node.name === 'pattern' && node.attributes.width === '0' ) { detachNodeFromParent(node, parentNode); return; } // Pattern with zero height // // https://www.w3.org/TR/SVG11/pservers.html#PatternElementHeightAttribute // "A value of zero disables rendering of the element (i.e., no paint is applied)" // // if ( patternHeight0 && node.name === 'pattern' && node.attributes.height === '0' ) { detachNodeFromParent(node, parentNode); return; } // Image with zero width // // https://www.w3.org/TR/SVG11/struct.html#ImageElementWidthAttribute // "A value of zero disables rendering of the element" // // if ( imageWidth0 && node.name === 'image' && node.attributes.width === '0' ) { detachNodeFromParent(node, parentNode); return; } // Image with zero height // // https://www.w3.org/TR/SVG11/struct.html#ImageElementHeightAttribute // "A value of zero disables rendering of the element" // // if ( imageHeight0 && node.name === 'image' && node.attributes.height === '0' ) { detachNodeFromParent(node, parentNode); return; } // Path with empty data // // https://www.w3.org/TR/SVG11/paths.html#DAttribute // // if (pathEmptyD && node.name === 'path') { if (node.attributes.d == null) { detachNodeFromParent(node, parentNode); return; } const pathData = parsePathData(node.attributes.d); if (pathData.length === 0) { detachNodeFromParent(node, parentNode); return; } // keep single point paths for markers if ( pathData.length === 1 && computedStyle['marker-start'] == null && computedStyle['marker-end'] == null ) { detachNodeFromParent(node, parentNode); return; } return; } // Polyline with empty points // // https://www.w3.org/TR/SVG11/shapes.html#PolylineElementPointsAttribute // // if ( polylineEmptyPoints && node.name === 'polyline' && node.attributes.points == null ) { detachNodeFromParent(node, parentNode); return; } // Polygon with empty points // // https://www.w3.org/TR/SVG11/shapes.html#PolygonElementPointsAttribute // // if ( polygonEmptyPoints && node.name === 'polygon' && node.attributes.points == null ) { detachNodeFromParent(node, parentNode); return; } }, }, }; };