Skip to main content

rspack_lightningcss/rules/
view_transition.rs

1//! The `@view-transition` rule.
2
3use super::Location;
4use crate::error::{ParserError, PrinterError};
5use crate::properties::custom::CustomProperty;
6use crate::stylesheet::ParserOptions;
7use crate::traits::{Parse, ToCss};
8use crate::values::ident::NoneOrCustomIdentList;
9#[cfg(feature = "visitor")]
10use crate::visitor::Visit;
11use cssparser::*;
12
13/// A [@view-transition](https://drafts.csswg.org/css-view-transitions-2/#view-transition-rule) rule.
14#[derive(Debug, PartialEq, Clone)]
15#[cfg_attr(feature = "visitor", derive(Visit))]
16#[cfg_attr(feature = "into_owned", derive(rspack_lightningcss_static_self::IntoOwned))]
17#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
18#[cfg_attr(feature = "jsonschema", derive(schemars::JsonSchema))]
19pub struct ViewTransitionRule<'i> {
20  /// Declarations in the `@view-transition` rule.
21  #[cfg_attr(feature = "serde", serde(borrow))]
22  pub properties: Vec<ViewTransitionProperty<'i>>,
23  /// The location of the rule in the source file.
24  #[cfg_attr(feature = "visitor", skip_visit)]
25  pub loc: Location,
26}
27
28/// A property within a `@view-transition` rule.
29///
30///  See [ViewTransitionRule](ViewTransitionRule).
31#[derive(Debug, Clone, PartialEq)]
32#[cfg_attr(feature = "visitor", derive(Visit))]
33#[cfg_attr(feature = "into_owned", derive(rspack_lightningcss_static_self::IntoOwned))]
34#[cfg_attr(
35  feature = "serde",
36  derive(serde::Serialize, serde::Deserialize),
37  serde(tag = "property", content = "value", rename_all = "kebab-case")
38)]
39#[cfg_attr(feature = "jsonschema", derive(schemars::JsonSchema))]
40pub enum ViewTransitionProperty<'i> {
41  /// The `navigation` property.
42  Navigation(Navigation),
43  /// The `types` property.
44  #[cfg_attr(feature = "serde", serde(borrow))]
45  Types(NoneOrCustomIdentList<'i>),
46  /// An unknown or unsupported property.
47  Custom(CustomProperty<'i>),
48}
49
50/// A value for the [navigation](https://drafts.csswg.org/css-view-transitions-2/#view-transition-navigation-descriptor)
51/// property in a `@view-transition` rule.
52#[derive(Debug, Clone, PartialEq, Default, Parse, ToCss)]
53#[cfg_attr(feature = "visitor", derive(Visit))]
54#[cfg_attr(feature = "into_owned", derive(rspack_lightningcss_static_self::IntoOwned))]
55#[cfg_attr(
56  feature = "serde",
57  derive(serde::Serialize, serde::Deserialize),
58  serde(rename_all = "kebab-case")
59)]
60#[cfg_attr(feature = "jsonschema", derive(schemars::JsonSchema))]
61pub enum Navigation {
62  /// There will be no transition.
63  #[default]
64  None,
65  /// The transition will be enabled if the navigation is same-origin.
66  Auto,
67}
68
69pub(crate) struct ViewTransitionDeclarationParser;
70
71impl<'i> cssparser::DeclarationParser<'i> for ViewTransitionDeclarationParser {
72  type Declaration = ViewTransitionProperty<'i>;
73  type Error = ParserError<'i>;
74
75  fn parse_value<'t>(
76    &mut self,
77    name: CowRcStr<'i>,
78    input: &mut Parser<'i, 't>,
79    _declaration_start: &ParserState,
80  ) -> Result<Self::Declaration, ParseError<'i, Self::Error>> {
81    let state = input.state();
82    match_ignore_ascii_case! { &name,
83      "navigation" => {
84        // https://drafts.csswg.org/css-view-transitions-2/#view-transition-navigation-descriptor
85        if let Ok(navigation) = Navigation::parse(input) {
86          return Ok(ViewTransitionProperty::Navigation(navigation));
87        }
88      },
89      "types" => {
90        // https://drafts.csswg.org/css-view-transitions-2/#types-cross-doc
91        if let Ok(types) = NoneOrCustomIdentList::parse(input) {
92          return Ok(ViewTransitionProperty::Types(types));
93        }
94      },
95      _ => return Err(input.new_custom_error(ParserError::InvalidDeclaration))
96    }
97
98    input.reset(&state);
99    return Ok(ViewTransitionProperty::Custom(CustomProperty::parse(
100      name.into(),
101      input,
102      &ParserOptions::default(),
103    )?));
104  }
105}
106
107/// Default methods reject all at rules.
108impl<'i> AtRuleParser<'i> for ViewTransitionDeclarationParser {
109  type Prelude = ();
110  type AtRule = ViewTransitionProperty<'i>;
111  type Error = ParserError<'i>;
112}
113
114impl<'i> QualifiedRuleParser<'i> for ViewTransitionDeclarationParser {
115  type Prelude = ();
116  type QualifiedRule = ViewTransitionProperty<'i>;
117  type Error = ParserError<'i>;
118}
119
120impl<'i> RuleBodyItemParser<'i, ViewTransitionProperty<'i>, ParserError<'i>> for ViewTransitionDeclarationParser {
121  fn parse_qualified(&self) -> bool {
122    false
123  }
124
125  fn parse_declarations(&self) -> bool {
126    true
127  }
128}
129
130impl<'i> ViewTransitionRule<'i> {
131  pub(crate) fn parse<'t>(
132    input: &mut Parser<'i, 't>,
133    loc: Location,
134  ) -> Result<Self, ParseError<'i, ParserError<'i>>> {
135    let mut decl_parser = ViewTransitionDeclarationParser;
136    let mut parser = RuleBodyParser::new(input, &mut decl_parser);
137    let mut properties = vec![];
138    while let Some(decl) = parser.next() {
139      if let Ok(decl) = decl {
140        properties.push(decl);
141      }
142    }
143
144    Ok(ViewTransitionRule { properties, loc })
145  }
146}
147
148impl<'i> ToCss for ViewTransitionRule<'i> {
149  fn to_css<PrinterT: crate::printer::PrinterTrait>(&self, dest: &mut PrinterT) -> Result<(), PrinterError> {
150    dest.add_mapping(self.loc);
151    dest.write_str("@view-transition")?;
152    dest.whitespace()?;
153    dest.write_char('{')?;
154    dest.indent();
155    let len = self.properties.len();
156    for (i, prop) in self.properties.iter().enumerate() {
157      dest.newline()?;
158      prop.to_css(dest)?;
159      if i != len - 1 || !dest.options().minify {
160        dest.write_char(';')?;
161      }
162    }
163    dest.dedent();
164    dest.newline()?;
165    dest.write_char('}')?;
166    Ok(())
167  }
168}
169
170impl<'i> ToCss for ViewTransitionProperty<'i> {
171  fn to_css<PrinterT: crate::printer::PrinterTrait>(&self, dest: &mut PrinterT) -> Result<(), PrinterError> {
172    macro_rules! property {
173      ($prop: literal, $value: expr) => {{
174        dest.write_str($prop)?;
175        dest.delim(':', false)?;
176        $value.to_css(dest)
177      }};
178    }
179
180    match self {
181      ViewTransitionProperty::Navigation(f) => property!("navigation", f),
182      ViewTransitionProperty::Types(t) => property!("types", t),
183      ViewTransitionProperty::Custom(custom) => {
184        dest.write_str(custom.name.as_ref())?;
185        dest.delim(':', false)?;
186        custom.value.to_css(dest, true)
187      }
188    }
189  }
190}