Skip to main content
On this pageConstants

Ui/VirtualList/test

Constants

ApplyScroll

constsource
const ApplyScroll: LayeredCommandDefinitionWithArgs<"VirtualList/ApplyScroll", {
  id: String
  request: TaggedUnion<{
    Anchor: {
      anchor: TaggedUnion<{
        End: {}
        Offset: {
          scrollTop: Number
        }
        Row: {
          index: Number
          key: String
          viewportOffset: Number
        }
      }>
    }
    Target: {
      alignment: Literals<readonly ["Start", "Center", "End", "Nearest"]>
      target: TaggedUnion<{
        End: {}
        Index: {
          index: Number
        }
        Key: {
          key: String
        }
        Offset: {
          offset: Number
        }
      }>
    }
  }>
  version: Number
}, {
  _tag: "CompletedApplyScroll"
  outcome: {
    _tag: "Skipped"
  } | {
    _tag: "Applied"
    anchor: {
      _tag: "None"
    } | {
      _tag: "Row"
      index: number
      key: string
      viewportOffset: number
    }
    containerHeight: number
    scrollHeight: number
    scrollTop: number
  }
  version: number
}> | DefinitionWithArgsNameKeyed<"VirtualList/ApplyScroll", {
  id: String
  request: TaggedUnion<{
    Anchor: {
      anchor: TaggedUnion<{
        End: {}
        Offset: {
          scrollTop: Number
        }
        Row: {
          index: Number
          key: String
          viewportOffset: Number
        }
      }>
    }
    Target: {
      alignment: Literals<readonly ["Start", "Center", "End", "Nearest"]>
      target: TaggedUnion<{
        End: {}
        Index: {
          index: Number
        }
        Key: {
          key: String
        }
        Offset: {
          offset: Number
        }
      }>
    }
  }>
  version: Number
}, Effect<{
  _tag: "CompletedApplyScroll"
  outcome: {
    _tag: "Skipped"
  } | {
    _tag: "Applied"
    anchor: {
      _tag: "None"
    } | {
      _tag: "Row"
      index: number
      key: string
      viewportOffset: number
    }
    containerHeight: number
    scrollHeight: number
    scrollTop: number
  }
  version: number
}, never, Handler<"VirtualList/ApplyScroll", {
  id: string
  request: {
    _tag: "Target"
    alignment: "Start" | "End" | "Center" | "Nearest"
    target: {
      _tag: "Key"
      key: string
    } | {
      _tag: "Offset"
      offset: number
    } | {
      _tag: "End"
    } | {
      _tag: "Index"
      index: number
    }
  } | {
    _tag: "Anchor"
    anchor: {
      _tag: "End"
    } | {
      _tag: "Row"
      index: number
      key: string
      viewportOffset: number
    } | {
      _tag: "Offset"
      scrollTop: number
    }
  }
  version: number
}, {
  _tag: "CompletedApplyScroll"
  outcome: {
    _tag: "Skipped"
  } | {
    _tag: "Applied"
    anchor: {
      _tag: "None"
    } | {
      _tag: "Row"
      index: number
      key: string
      viewportOffset: number
    }
    containerHeight: number
    scrollHeight: number
    scrollTop: number
  }
  version: number
}>>> | DefinitionWithArgs<"VirtualList/ApplyScroll", {
  id: String
  request: TaggedUnion<{
    Anchor: {
      anchor: TaggedUnion<{
        End: {}
        Offset: {
          scrollTop: Number
        }
        Row: {
          index: Number
          key: String
          viewportOffset: Number
        }
      }>
    }
    Target: {
      alignment: Literals<readonly ["Start", "Center", "End", "Nearest"]>
      target: TaggedUnion<{
        End: {}
        Index: {
          index: Number
        }
        Key: {
          key: String
        }
        Offset: {
          offset: Number
        }
      }>
    }
  }>
  version: Number
}, Pick<{
  id: string
  request: {
    _tag: "Target"
    alignment: "Start" | "End" | "Center" | "Nearest"
    target: {
      _tag: "Key"
      key: string
    } | {
      _tag: "Offset"
      offset: number
    } | {
      _tag: "End"
    } | {
      _tag: "Index"
      index: number
    }
  } | {
    _tag: "Anchor"
    anchor: {
      _tag: "End"
    } | {
      _tag: "Row"
      index: number
      key: string
      viewportOffset: number
    } | {
      _tag: "Offset"
      scrollTop: number
    }
  }
  version: number
}, "id" | "version" | "request">, Effect<{
  _tag: "CompletedApplyScroll"
  outcome: {
    _tag: "Skipped"
  } | {
    _tag: "Applied"
    anchor: {
      _tag: "None"
    } | {
      _tag: "Row"
      index: number
      key: string
      viewportOffset: number
    }
    containerHeight: number
    scrollHeight: number
    scrollTop: number
  }
  version: number
}, never, Handler<"VirtualList/ApplyScroll", {
  id: string
  request: {
    _tag: "Target"
    alignment: "Start" | "End" | "Center" | "Nearest"
    target: {
      _tag: "Key"
      key: string
    } | {
      _tag: "Offset"
      offset: number
    } | {
      _tag: "End"
    } | {
      _tag: "Index"
      index: number
    }
  } | {
    _tag: "Anchor"
    anchor: {
      _tag: "End"
    } | {
      _tag: "Row"
      index: number
      key: string
      viewportOffset: number
    } | {
      _tag: "Offset"
      scrollTop: number
    }
  }
  version: number
}, {
  _tag: "CompletedApplyScroll"
  outcome: {
    _tag: "Skipped"
  } | {
    _tag: "Applied"
    anchor: {
      _tag: "None"
    } | {
      _tag: "Row"
      index: number
      key: string
      viewportOffset: number
    }
    containerHeight: number
    scrollHeight: number
    scrollTop: number
  }
  version: number
}>>> & Readonly<{
  layer: Layer<Handler<"VirtualList/ApplyScroll", {
    id: string
    request: {
      _tag: "Target"
      alignment: "Start" | "End" | "Center" | "Nearest"
      target: {
        _tag: "Key"
        key: string
      } | {
        _tag: "Offset"
        offset: number
      } | {
        _tag: "End"
      } | {
        _tag: "Index"
        index: number
      }
    } | {
      _tag: "Anchor"
      anchor: {
        _tag: "End"
      } | {
        _tag: "Row"
        index: number
        key: string
        viewportOffset: number
      } | {
        _tag: "Offset"
        scrollTop: number
      }
    }
    version: number
  }, {
    _tag: "CompletedApplyScroll"
    outcome: {
      _tag: "Skipped"
    } | {
      _tag: "Applied"
      anchor: {
        _tag: "None"
      } | {
        _tag: "Row"
        index: number
        key: string
        viewportOffset: number
      }
      containerHeight: number
      scrollHeight: number
      scrollTop: number
    }
    version: number
  }>, never, never>
}> & Readonly<{
  toLayer: ToLayer<"VirtualList/ApplyScroll", {
    id: string
    request: {
      _tag: "Target"
      alignment: "Start" | "End" | "Center" | "Nearest"
      target: {
        _tag: "Key"
        key: string
      } | {
        _tag: "Offset"
        offset: number
      } | {
        _tag: "End"
      } | {
        _tag: "Index"
        index: number
      }
    } | {
      _tag: "Anchor"
      anchor: {
        _tag: "End"
      } | {
        _tag: "Row"
        index: number
        key: string
        viewportOffset: number
      } | {
        _tag: "Offset"
        scrollTop: number
      }
    }
    version: number
  }, {
    _tag: "CompletedApplyScroll"
    outcome: {
      _tag: "Skipped"
    } | {
      _tag: "Applied"
      anchor: {
        _tag: "None"
      } | {
        _tag: "Row"
        index: number
        key: string
        viewportOffset: number
      }
      containerHeight: number
      scrollHeight: number
      scrollTop: number
    }
    version: number
  }>
}>

ObserveVirtualList

constsource
/**
 * Container-owned Mount that tracks scrolling, container resizing, and
 *  rendered row measurements for dynamic-height lists.
 */
const ObserveVirtualList: LayeredStreamMountDefinitionWithArgs<"VirtualList/ObserveVirtualList", {
  id: String
}, {
  _tag: "ResizedContainer"
  containerHeight: number
  containerWidth: number
} | {
  _tag: "MeasuredRows"
  measurements: readonly Array<{
    height: number
    key: string
    layoutVersion: number
  }>
} | {
  _tag: "ObservedContainerScroll"
  anchor: {
    _tag: "None"
  } | {
    _tag: "Row"
    index: number
    key: string
    viewportOffset: number
  }
  containerHeight: number
  scrollHeight: number
  scrollTop: number
}> & Readonly<{
  layer: Layer<Handler<"VirtualList/ObserveVirtualList", Readonly<{
    element: Element
    viewStateChanges: Stream<"Live" | "Paused">
  }> & {
    id: string
  }, {
    _tag: "ResizedContainer"
    containerHeight: number
    containerWidth: number
  } | {
    _tag: "MeasuredRows"
    measurements: readonly Array<{
      height: number
      key: string
      layoutVersion: number
    }>
  } | {
    _tag: "ObservedContainerScroll"
    anchor: {
      _tag: "None"
    } | {
      _tag: "Row"
      index: number
      key: string
      viewportOffset: number
    }
    containerHeight: number
    scrollHeight: number
    scrollTop: number
  }>, never, never>
}>