All files / src/render index.ts

94% Statements 141/150
90.76% Branches 108/119
90% Functions 36/40
95.07% Lines 135/142

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 51736x   36x 36x           36x 36x 36x 36x           36x 36x 99x 99x 99x 99x 99x 99x 99x 99x 99x 99x   99x   700x 700x 700x 700x 700x   700x   700x 1400x                           700x             700x           700x             700x           700x                                 1624x   1621x 1621x                 1621x       57x             525x   998x 998x       525x       525x 508x 508x                           700x 700x 369x 369x 345x             700x 700x   700x                                                                                                                     153x     359x 359x   359x 330x     359x 42x     359x 359x             332x 332x 332x 332x 332x 332x 332x 332x 332x             42x 42x 42x 42x 42x               8x 8x                     52x                   652x         168x               669x                                       629x 364x                 80x                   525x   525x 525x 525x             193x 193x 193x 193x 193x           971x             1075x   1075x 32x 32x     1075x           1914x               116x               122x               19x 19x 19x 9x   10x                                     1596x                               751x 13x     751x 751x   751x             4022x             4x         286x     35x           900x 746x   154x 57x 57x 27x   57x     97x 97x 776x 776x   776x 171x       97x       700x     36x 36x  
import sync, { cancelSync } from "framesync"
import { MotionStyle } from "../motion/types"
import { motionValue, MotionValue } from "../value"
import { isMotionValue } from "../value/utils/is-motion-value"
import {
    VisualElement,
    VisualElementConfig,
    VisualElementOptions,
} from "./types"
import { variantPriorityOrder } from "./utils/animation-state"
import { createLifecycles } from "./utils/lifecycles"
import { updateMotionValuesFromProps } from "./utils/motion-values"
import {
    checkIfControllingVariants,
    checkIfVariantNode,
    isVariantLabel,
} from "./utils/variants"
 
export const visualElement =
    <Instance, MutableState, Options>({
        treeType = "",
        build,
        getBaseTarget,
        makeTargetAnimatable,
        measureViewportBox,
        render: renderInstance,
        readValueFromInstance,
        removeValueFromRenderState,
        sortNodePosition,
        scrapeMotionValuesFromProps,
    }: VisualElementConfig<Instance, MutableState, Options>) =>
    (
        {
            parent,
            props,
            presenceId,
            blockInitialAnimation,
            visualState,
        }: VisualElementOptions<Instance>,
        Ioptions: Options = {} as Options
    ) => {
        let isMounted = false
        const { latestValues, renderState } = visualState
 
        /**
         * The instance of the render-specific node that will be hydrated by the
         * exposed React ref. So for example, this visual element can host a
         * HTMLElement, plain object, or Three.js object. The functions provided
         * in VisualElementConfig allow us to interface with this instance.
         */
        let instance: Instance | undefined
 
        /**
         * Manages the subscriptions for a visual element's lifecycle, for instance
         * onRender
         */
        const lifecycles = createLifecycles()
 
        /**
         * A map of all motion values attached to this visual element. Motion
         * values are source of truth for any given animated value. A motion
         * value might be provided externally by the component via props.
         */
        const values = new Map<string, MotionValue>()
 
        /**
         * A map of every subscription that binds the provided or generated
         * motion values onChange listeners to this visual element.
         */
        const valueSubscriptions = new Map<string, () => void>()
 
        /**
         * A reference to the previously-provided motion values as returned
         * from scrapeMotionValuesFromProps. We use the keys in here to determine
         * if any motion values need to be removed after props are updated.
         */
        let prevMotionValues: MotionStyle = {}
 
        /**
         * When values are removed from all animation props we need to search
         * for a fallback value to animate to. These values are tracked in baseTarget.
         */
        const baseTarget: { [key: string]: string | number | null } = {
            ...latestValues,
        }
 
        // Internal methods ========================
 
        /**
         * On mount, this will be hydrated with a callback to disconnect
         * this visual element from its parent on unmount.
         */
        let removeFromVariantTree: undefined | (() => void)
 
        /**
         * Render the element with the latest styles outside of the React
         * render lifecycle
         */
        function render() {
            if (!instance || !isMounted) return
 
            triggerBuild()
            renderInstance(
                instance,
                renderState,
                props.style,
                element.projection
            )
        }
 
        function triggerBuild() {
            build(element, renderState, latestValues, options, props)
        }
 
        function update() {
            lifecycles.notifyUpdate(latestValues)
        }
 
        /**
         *
         */
        function bindToMotionValue(key: string, value: MotionValue) {
            const removeOnChange = value.onChange(
                (latestValue: string | number) => {
                    latestValues[key] = latestValue
                    props.onUpdate && sync.update(update, false, true)
                }
            )
 
            const removeOnRenderRequest = value.onRenderRequest(
                element.scheduleRender
            )
 
            valueSubscriptions.set(key, () => {
                removeOnChange()
                removeOnRenderRequest()
            })
        }
 
        /**
         * Any motion values that are provided to the element when created
         * aren't yet bound to the element, as this would technically be impure.
         * However, we iterate through the motion values and set them to the
         * initial values for this component.
         *
         * TODO: This is impure and we should look at changing this to run on mount.
         * Doing so will break some tests but this isn't neccessarily a breaking change,
         * more a reflection of the test.
         */
        const initialMotionValues = scrapeMotionValuesFromProps(props)
        for (const key in initialMotionValues) {
            const value = initialMotionValues[key]
            if (latestValues[key] !== undefined && isMotionValue(value)) {
                value.set(latestValues[key], false)
            }
        }
 
        /**
         * Determine what role this visual element should take in the variant tree.
         */
        const isControllingVariants = checkIfControllingVariants(props)
        const isVariantNode = checkIfVariantNode(props)
 
        const element: VisualElement<Instance> = {
            treeType,
 
            /**
             * This is a mirror of the internal instance prop, which keeps
             * VisualElement type-compatible with React's RefObject.
             */
            current: null,
 
            /**
             * The depth of this visual element within the visual element tree.
             */
            depth: parent ? parent.depth + 1 : 0,
 
            parent,
 
            children: new Set(),
 
            /**
             *
             */
            presenceId,
 
            /**
             * If this component is part of the variant tree, it should track
             * any children that are also part of the tree. This is essentially
             * a shadow tree to simplify logic around how to stagger over children.
             */
            variantChildren: isVariantNode ? new Set() : undefined,
 
            /**
             * Whether this instance is visible. This can be changed imperatively
             * by the projection tree, is analogous to CSS's visibility in that
             * hidden elements should take up layout, and needs enacting by the configured
             * render function.
             */
            isVisible: undefined,
 
            /**
             * Normally, if a component is controlled by a parent's variants, it can
             * rely on that ancestor to trigger animations further down the tree.
             * However, if a component is created after its parent is mounted, the parent
             * won't trigger that mount animation so the child needs to.
             *
             * TODO: This might be better replaced with a method isParentMounted
             */
            manuallyAnimateOnMount: Boolean(parent?.isMounted()),
 
            /**
             * This can be set by AnimatePresence to force components that mount
             * at the same time as it to mount as if they have initial={false} set.
             */
            blockInitialAnimation,
 
            /**
             * Determine whether this component has mounted yet. This is mostly used
             * by variant children to determine whether they need to trigger their
             * own animations on mount.
             */
            isMounted: () => Boolean(instance),
 
            mount(newInstance: Instance) {
                isMounted = true
                instance = element.current = newInstance
 
                if (element.projection) {
                    element.projection.mount(newInstance)
                }
 
                if (isVariantNode && parent && !isControllingVariants) {
                    removeFromVariantTree = parent?.addVariantChild(element)
                }
 
                parent?.children.add(element)
                element.setProps(props)
            },
 
            /**
             *
             */
            unmount() {
                element.projection?.unmount()
                cancelSync.update(update)
                cancelSync.render(render)
                valueSubscriptions.forEach((remove) => remove())
                removeFromVariantTree?.()
                parent?.children.delete(element)
                lifecycles.clearAllListeners()
                instance = undefined
                isMounted = false
            },
 
            /**
             * Add a child visual element to our set of children.
             */
            addVariantChild(child) {
                const closestVariantNode = element.getClosestVariantNode()
                Eif (closestVariantNode) {
                    closestVariantNode.variantChildren?.add(child)
                    return () =>
                        closestVariantNode.variantChildren!.delete(child)
                }
            },
 
            sortNodePosition(other: VisualElement) {
                /**
                 * If these nodes aren't even of the same type we can't compare their depth.
                 */
                Iif (!sortNodePosition || treeType !== other.treeType) return 0
                return sortNodePosition(
                    element.getInstance() as Instance,
                    other.getInstance()
                )
            },
 
            /**
             * Returns the closest variant node in the tree starting from
             * this visual element.
             */
            getClosestVariantNode: () =>
                isVariantNode ? element : parent?.getClosestVariantNode(),
 
            /**
             * Expose the latest layoutId prop.
             */
            getLayoutId: () => props.layoutId,
 
            /**
             * Returns the current instance.
             */
            getInstance: () => instance!,
 
            /**
             * Get/set the latest static values.
             */
            getStaticValue: (key) => latestValues[key],
            setStaticValue: (key, value) => (latestValues[key] = value),
 
            /**
             * Returns the latest motion value state. Currently only used to take
             * a snapshot of the visual element - perhaps this can return the whole
             * visual state
             */
            getLatestValues: () => latestValues,
 
            /**
             * Set the visiblity of the visual element. If it's changed, schedule
             * a render to reflect these changes.
             */
            setVisibility(visibility) {
                if (element.isVisible === visibility) return
                element.isVisible = visibility
 
                element.scheduleRender()
            },
 
            /**
             * Make a target animatable by Popmotion. For instance, if we're
             * trying to animate width from 100px to 100vw we need to measure 100vw
             * in pixels to determine what we really need to animate to. This is also
             * pluggable to support Framer's custom value types like Color,
             * and CSS variables.
             */
            makeTargetAnimatable(target, canMutate = true) {
                return makeTargetAnimatable(element, target, props, canMutate)
            },
 
            /**
             * Measure the current viewport box with or without transforms.
             * Only measures axis-aligned boxes, rotate and skew must be manually
             * removed with a re-render to work.
             */
            measureViewportBox() {
                return measureViewportBox(instance!, props)
            },
 
            // Motion values ========================
 
            /**
             * Add a motion value and bind it to this visual element.
             */
            addValue(key, value) {
                // Remove existing value if it exists
                if (element.hasValue(key)) element.removeValue(key)
 
                values.set(key, value)
                latestValues[key] = value.get()
                bindToMotionValue(key, value)
            },
 
            /**
             * Remove a motion value and unbind any active subscriptions.
             */
            removeValue(key) {
                values.delete(key)
                valueSubscriptions.get(key)?.()
                valueSubscriptions.delete(key)
                delete latestValues[key]
                removeValueFromRenderState(key, renderState)
            },
 
            /**
             * Check whether we have a motion value for this key
             */
            hasValue: (key) => values.has(key),
 
            /**
             * Get a motion value for this key. If called with a default
             * value, we'll create one if none exists.
             */
            getValue(key: string, defaultValue?: string | number) {
                let value = values.get(key)
 
                if (value === undefined && defaultValue !== undefined) {
                    value = motionValue(defaultValue)
                    element.addValue(key, value)
                }
 
                return value as MotionValue
            },
 
            /**
             * Iterate over our motion values.
             */
            forEachValue: (callback) => values.forEach(callback),
 
            /**
             * If we're trying to animate to a previously unencountered value,
             * we need to check for it in our state and as a last resort read it
             * directly from the instance (which might have performance implications).
             */
            readValue: (key: string) =>
                latestValues[key] ??
                readValueFromInstance(instance!, key, options),
 
            /**
             * Set the base target to later animate back to. This is currently
             * only hydrated on creation and when we first read a value.
             */
            setBaseTarget(key, value) {
                baseTarget[key] = value
            },
 
            /**
             * Find the base target for a value thats been removed from all animation
             * props.
             */
            getBaseTarget(key) {
                Eif (getBaseTarget) {
                    const target = getBaseTarget(props, key)
                    if (target !== undefined && !isMotionValue(target))
                        return target
                }
                return baseTarget[key]
            },
 
            // Lifecyles ========================
 
            ...lifecycles,
 
            /**
             * Build the renderer state based on the latest visual state.
             */
            build() {
                triggerBuild()
                return renderState
            },
 
            /**
             * Schedule a render on the next animation frame.
             */
            scheduleRender() {
                sync.render(render, false, true)
            },
 
            /**
             * Synchronously fire render. It's prefered that we batch renders but
             * in many circumstances, like layout measurement, we need to run this
             * synchronously. However in those instances other measures should be taken
             * to batch reads/writes.
             */
            syncRender: render,
 
            /**
             * Update the provided props. Ensure any newly-added motion values are
             * added to our map, old ones removed, and listeners updated.
             */
            setProps(newProps) {
                if (newProps.transformTemplate || props.transformTemplate) {
                    element.scheduleRender()
                }
 
                props = newProps
                lifecycles.updatePropListeners(newProps)
 
                prevMotionValues = updateMotionValuesFromProps(
                    element,
                    scrapeMotionValuesFromProps(props),
                    prevMotionValues
                )
            },
 
            getProps: () => props,
 
            // Variants ==============================
 
            /**
             * Returns the variant definition with a given name.
             */
            getVariant: (name) => props.variants?.[name],
 
            /**
             * Returns the defined default transition on this component.
             */
            getDefaultTransition: () => props.transition,
 
            getTransformPagePoint: () => {
                return (props as any).transformPagePoint
            },
 
            /**
             * Used by child variant nodes to get the closest ancestor variant props.
             */
            getVariantContext(startAtParent = false) {
                if (startAtParent) return parent?.getVariantContext()
 
                if (!isControllingVariants) {
                    const context = parent?.getVariantContext() || {}
                    if (props.initial !== undefined) {
                        context.initial = props.initial as any
                    }
                    return context
                }
 
                const context = {}
                for (let i = 0; i < numVariantProps; i++) {
                    const name = variantProps[i]
                    const prop = props[name]
 
                    if (isVariantLabel(prop) || prop === false) {
                        context[name] = prop
                    }
                }
 
                return context
            },
        }
 
        return element
    }
 
const variantProps = ["initial", ...variantPriorityOrder]
const numVariantProps = variantProps.length