Skip to main content

partials

                            
                              
                                import
                                
                                {
                                ...
                                }
                                
                                from
                                
                                "@motion-canvas/2d/lib/partials"
                                ;

Classes ​

  • Filter
  • Gradient
  • Pattern

Interfaces ​

  • FilterProps
  • GradientProps
  • GradientStop
  • PatternProps

Type Aliases ​

CanvasRepetition ​ 

                            
                              
                                type 
                                CanvasRepetition
                                 = 
                                
                                  
                                    
                                      null
                                    
                                    
                                      'repeat'
                                    
                                    
                                      'repeat-x'
                                    
                                    
                                      'repeat-y'
                                    
                                    
                                      'no-repeat'

CanvasStyle ​ 

                            
                              
                                type 
                                CanvasStyle
                                 = 
                                
                                  
                                    
                                      null
                                    
                                    
                                      Color
                                    
                                    
                                      Gradient
                                    
                                    
                                      Pattern

DesiredLength ​ 

                            
                              
                                type 
                                DesiredLength
                                 = 
                                
                                  
                                    
                                      Length
                                    
                                    
                                      null

Represents a desired length used internally by layout Nodes.

When the desired length is set to null it represents a default value forwhatever property it describes.

FlexBasis ​ 

                            
                              
                                type 
                                FlexBasis
                                 = 
                                
                                  
                                    
                                      Length
                                    
                                    
                                      'content'
                                    
                                    
                                      'max-content'
                                    
                                    
                                      'min-content'
                                    
                                    
                                      'fit-content'
                                    
                                    
                                      null

FlexContent ​ 

                            
                              
                                type 
                                FlexContent
                                 = 
                                
                                  
                                    
                                      'center'
                                    
                                    
                                      'start'
                                    
                                    
                                      'end'
                                    
                                    
                                      'space-between'
                                    
                                    
                                      'space-around'
                                    
                                    
                                      'space-evenly'
                                    
                                    
                                      'stretch'

FlexDirection ​ 

                            
                              
                                type 
                                FlexDirection
                                 = 
                                
                                  
                                    
                                      'row'
                                    
                                    
                                      'row-reverse'
                                    
                                    
                                      'column'
                                    
                                    
                                      'column-reverse'

FlexItems ​ 

                            
                              
                                type 
                                FlexItems
                                 = 
                                
                                  
                                    
                                      'center'
                                    
                                    
                                      'start'
                                    
                                    
                                      'end'
                                    
                                    
                                      'stretch'
                                    
                                    
                                      'baseline'

FlexWrap ​ 

                            
                              
                                type 
                                FlexWrap
                                 = 
                                
                                  
                                    
                                      'nowrap'
                                    
                                    
                                      'wrap'
                                    
                                    
                                      'wrap-reverse'

GradientType ​ 

                            
                              
                                type 
                                GradientType
                                 = 
                                
                                  
                                    
                                      'linear'
                                    
                                    
                                      'conic'
                                    
                                    
                                      'radial'

LayoutMode ​ 

                            
                              
                                type 
                                LayoutMode
                                 = 
                                
                                  
                                    
                                      boolean
                                    
                                    
                                      null

Length ​ 

                            
                              
                                type 
                                Length
                                 = 
                                
                                  
                                    
                                      number
                                    
                                    
                                      `
                                      ${
                                      number
                                      }
                                      %
                                      `

Represents a length used by most layout properties.

The value can be either:

  • number - the desired length in pixels
  • ${number}% - a string with the desired length in percents, for example '50%'

LengthLimit ​ 

                            
                              
                                type 
                                LengthLimit
                                 = 
                                
                                  
                                    
                                      Length
                                    
                                    
                                      null
                                    
                                    
                                      'max-content'
                                    
                                    
                                      'min-content'

Represents a length limit used by layout properties such as max-width .

PossibleCanvasStyle ​ 

                            
                              
                                type 
                                PossibleCanvasStyle
                                 = 
                                
                                  
                                    
                                      null
                                    
                                    
                                      PossibleColor
                                    
                                    
                                      Gradient
                                    
                                    
                                      Pattern

TextWrap ​ 

                            
                              
                                type 
                                TextWrap
                                 = 
                                
                                  
                                    
                                      boolean
                                    
                                    
                                      'pre'

Functions ​

blur ​ 

                            
                              
                                public 
                                blur
                                
                                  
                                    
                                      value
                                      ?: 
                                      SignalValue
                                      
                                        
                                          
                                            number
                                          
                                        
                                      
                                    
                                  
                                
                                : 
                                Filter

Create a blur filter.

Parameters

brightness ​ 

                            
                              
                                public 
                                brightness
                                
                                  
                                    
                                      value
                                      ?: 
                                      SignalValue
                                      
                                        
                                          
                                            number
                                          
                                        
                                      
                                    
                                  
                                
                                : 
                                Filter

Create a brightness filter.

Parameters

contrast ​ 

                            
                              
                                public 
                                contrast
                                
                                  
                                    
                                      value
                                      ?: 
                                      SignalValue
                                      
                                        
                                          
                                            number
                                          
                                        
                                      
                                    
                                  
                                
                                : 
                                Filter

Create a contrast filter.

Parameters

grayscale ​ 

                            
                              
                                public 
                                grayscale
                                
                                  
                                    
                                      value
                                      ?: 
                                      SignalValue
                                      
                                        
                                          
                                            number
                                          
                                        
                                      
                                    
                                  
                                
                                : 
                                Filter

Create a grayscale filter.

Parameters

hue ​ 

                            
                              
                                public 
                                hue
                                
                                  
                                    
                                      value
                                      ?: 
                                      SignalValue
                                      
                                        
                                          
                                            number
                                          
                                        
                                      
                                    
                                  
                                
                                : 
                                Filter

Create a hue filter.

Parameters

invert ​ 

                            
                              
                                public 
                                invert
                                
                                  
                                    
                                      value
                                      ?: 
                                      SignalValue
                                      
                                        
                                          
                                            number
                                          
                                        
                                      
                                    
                                  
                                
                                : 
                                Filter

Create an invert filter.

Parameters

saturate ​ 

                            
                              
                                public 
                                saturate
                                
                                  
                                    
                                      value
                                      ?: 
                                      SignalValue
                                      
                                        
                                          
                                            number
                                          
                                        
                                      
                                    
                                  
                                
                                : 
                                Filter

Create a saturate filter.

Parameters

sepia ​ 

                            
                              
                                public 
                                sepia
                                
                                  
                                    
                                      value
                                      ?: 
                                      SignalValue
                                      
                                        
                                          
                                            number
                                          
                                        
                                      
                                    
                                  
                                
                                : 
                                Filter

Create a sepia filter.

Parameters