Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ClampLines<SS>

Type parameters

  • SS

Hierarchy

Index

Constructors

constructor

Properties

context

context: any

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType.

static contextType = MyContext
context!: React.ContextType<typeof MyContext>
deprecated

if used without a type annotation, or without static contextType

see

https://reactjs.org/docs/legacy-context.html

element

element: HTMLDivElement

handleResize

handleResize: (Anonymous function) & ICancelable = debounce(() => {this.setState({ noClamp: false });this.clampLines();}, this.props.delay)

innerElement

innerElement: HTMLSpanElement

lineHeight

lineHeight: number

maxHeight

maxHeight: number

original

original: string

props

props: Readonly<IClampLinesProps> & Readonly<object>

refs

refs: object

Type declaration

  • [key: string]: ReactInstance

ssr

ssr: boolean

state

state: Readonly<IClampLinesState>

Static Optional contextType

contextType: Context<any>

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

type MyContext = number
const Ctx = React.createContext<MyContext>(0)

class Foo extends React.Component {
  static contextType = Ctx
  context!: React.ContextType<typeof Ctx>
  render () {
    return <>My context's value: {this.context}</>;
  }
}
see

https://reactjs.org/docs/context.html#classcontexttype

Methods

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

  • UNSAFE_componentWillReceiveProps(nextProps: Readonly<IClampLinesProps>, nextContext: any): void

Optional UNSAFE_componentWillUpdate

clampLines

  • clampLines(): void

Optional componentDidCatch

  • componentDidCatch(error: Error, errorInfo: ErrorInfo): void
  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

componentDidMount

  • componentDidMount(): void

componentDidUpdate

  • componentDidUpdate(prevProps: any): void

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

  • componentWillReceiveProps(nextProps: Readonly<IClampLinesProps>, nextContext: any): void

Optional componentWillUnmount

  • componentWillUnmount(): void
  • Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    Returns void

Optional componentWillUpdate

forceUpdate

  • forceUpdate(callBack?: function): void
  • Parameters

    • Optional callBack: function
        • (): void
        • Returns void

    Returns void

getEllipsis

  • getEllipsis(): string

Optional getSnapshotBeforeUpdate

  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    Parameters

    Returns SS | null

render

  • render(): Element

renderClampedText

  • renderClampedText(): Element

renderResizable

  • renderResizable(): Element

setState

  • setState<K>(state: function | S | object, callback?: function): void
  • Type parameters

    • K: keyof IClampLinesState

    Parameters

    • state: function | S | object
    • Optional callback: function
        • (): void
        • Returns void

    Returns void

Optional shouldComponentUpdate

  • Called to determine whether the change in props and state should trigger a re-render.

    Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed.

    If false is returned, Component#render, componentWillUpdate and componentDidUpdate will not be called.

    Parameters

    Returns boolean

Static getDerivedStateFromProps

  • getDerivedStateFromProps(props: any, state: any): object

Object literals

Static defaultProps

defaultProps: object

className

className: string = ""

delay

delay: number = 300

ellipsis

ellipsis: string = "..."

extra

extra: null = null

lines

lines: number = 2

popWidth

popWidth: number = 250

prefix

prefix: string = "zent"

renderPop

renderPop: identity = identity

resizable

resizable: boolean = false

showPop

showPop: boolean = true

trigger

trigger: string = "hover"

Generated using TypeDoc