figma-schema 0.3.0

Figma REST API schema
Documentation 
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

use serde::{Deserialize, Serialize};

use super::{Color, Vector};

#[derive(Debug, Deserialize, Serialize, PartialEq, Eq, Hash)]
#[serde(rename_all = "SCREAMING_SNAKE_CASE")]
#[typeshare::typeshare]
pub enum EffectType {
    InnerShadow,
    DropShadow,
    LayerBlur,
    BackgroundBlur,
}

/// A visual effect such as a shadow or blur
///
/// [Figma documentation](https://www.figma.com/developers/api#effect-type)
#[derive(Debug, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
#[typeshare::typeshare]
pub struct Effect {
    /// Type of effect
    pub r#type: EffectType,
    /// Is the effect active?
    pub visible: bool,
    /// The color of the shadow
    #[serde(skip_serializing_if = "Option::is_none")]
    pub color: Option<Color>,
    /// How far the shadow is projected in the x and y directions
    #[serde(skip_serializing_if = "Option::is_none")]
    pub offset: Option<Vector>,
    /// How far the shadow spreads
    #[serde(skip_serializing_if = "Option::is_none")]
    pub spread: Option<f64>,
}

impl Effect {
    pub fn spread(&self) -> f64 {
        self.spread.unwrap_or(0.0)
    }
}