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 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400
#![doc = include_str!("../README.md")]
use css_style::{
box_align::*,
calc::{calc, Calc},
flexbox::*,
margin, padding,
prelude::*,
unit::percent,
Display, FlexDirection, Gap, Margin, Padding,
};
use yew::prelude::*;
pub type Align = JustifyContent;
pub type CrossAlign = AlignItems;
pub type AlignColumns = AlignContent;
pub type AlignRows = AlignContent;
pub use css_style::box_align::AlignSelf;
// ======================== Row Component ========================
/// Column properties.
///
/// Here you can find all properties that can be used with
/// [Column](crate::Column) component.
#[derive(Properties, Clone, PartialEq)]
pub struct ColumnProps {
pub children: Children,
/// Fill the available sapce vertically.
///
/// The default is `true`
#[prop_or(true)]
pub fill: bool,
/// Fill the available sapce horizontally.
///
/// The default is `false`
#[prop_or(false)]
pub cross_fill: bool,
/// Expand factor used to exapnd this column in direction relevant to it's
/// parent layout direction.
///
/// When the parent is `Row` it will expand horizontally, when the parent is
/// `Column` it will expand vertically.
///
/// Note: This only works when this `Column` inside another flex layout.
///
/// The default is `None`
#[prop_or_default]
pub expand_by: Option<f32>,
/// Shrink factor used to shrink this column in direction relevant to it's
/// parent layout direction when needed.
///
/// When the parent is `Row` it will shrink horizontally, when the parent is
/// `Column` it will shrink vertically.
///
/// Note: This only works when this `Column` inside another flex layout.
///
/// The default is `None`
#[prop_or_default]
pub shrink_by: Option<f32>,
/// Make this layout inline
///
/// The default is `false`
#[prop_or(false)]
pub inline: bool,
/// Reverse the order of the children
///
/// The default is `false`
#[prop_or(false)]
pub reverse: bool,
/// Wrap into another column when there is no more vertical space.
///
/// The default is `false`
#[prop_or(false)]
pub wrap: bool,
/// Align the children inside this column in main direction (horizontally).
///
/// The default is `None`
#[prop_or_default]
pub align: Option<Align>,
/// Align the children inside this column in the cross direction
/// (vertically).
///
/// The default is `None`
#[prop_or_default]
pub cross_align: Option<CrossAlign>,
/// Align this column when it's inside another layout, the alignment
/// direction is relevant to the parent layout direction
///
/// When the parent is `Row` it will align horizontally, when the parent is
/// `Column` it will align vertically.
///
/// Note: This only works when this `Column` inside another layout.
///
/// The default is `None`
#[prop_or_default]
pub align_self: Option<AlignSelf>,
/// Gap between children.
///
/// this take `css_style::Gap` value, which can take either one value that
/// defines the gap for both the columns (if there is any) and rows, or two
/// values one for rows and the other for columns.
///
/// The default is `None`
#[prop_or_default]
pub gap: Option<Gap>,
/// Reverse columns if there is more than one column within this `Column`.
///
/// The default is `false`
#[prop_or(false)]
pub reverse_columns: bool,
/// Align columns in the corss direction (horizontally) if there is more
/// than one column within this `Column`.
///
/// The default is `None`
#[prop_or_default]
pub align_columns: Option<AlignColumns>,
/// Padding for the `Column`
///
/// The default is `None`
#[prop_or_default]
pub padding: Option<Padding>,
/// Margin for the `Column`
///
/// The default is `None`
#[prop_or_default]
pub margin: Option<Margin>,
}
/// Column layout component.
///
/// See [column properties docs](crate::ColumnProps) for more details
/// on how to use them.
///
/// # Usage
///
/// ```rust
/// use yew_layout::{Column, Align};
/// # use yew::prelude::*;
///
/// # fn view() -> Html {
/// html! {
/// <Column align={ Align::Center } cross_fill=true wrap=true>
/// { "Column children.." }
/// </Column>
/// }
/// # }
/// ```
#[function_component(Column)]
pub fn column(props: &ColumnProps) -> Html {
let style = Style::default()
.display(match props.inline {
true => Display::InlineFlex,
false => Display::Flex,
})
.and_size(|mut size| {
let calc_pad = |padding: Option<&padding::Length>| {
padding.and_then(|p| Calc::try_from(p.clone()).ok())
};
let calc_marg = |margin: Option<&margin::Length>| {
margin.and_then(|p| Calc::try_from(p.clone()).ok())
};
let pad = props.padding.as_ref();
let marg = props.margin.as_ref();
if props.fill && !props.inline {
let height = calc(percent(1.0))
.try_sub(calc_pad(pad.map(|p| p.top.as_ref()).flatten()))
.try_sub(calc_pad(pad.map(|p| p.bottom.as_ref()).flatten()))
.try_sub(calc_marg(marg.map(|m| m.top.as_ref()).flatten()))
.try_sub(calc_marg(marg.map(|m| m.bottom.as_ref()).flatten()));
size = size.height(height);
}
if props.cross_fill && !props.inline {
let width = calc(percent(1.0))
.try_sub(calc_pad(pad.map(|p| p.left.as_ref()).flatten()))
.try_sub(calc_pad(pad.map(|p| p.right.as_ref()).flatten()))
.try_sub(calc_marg(marg.map(|m| m.left.as_ref()).flatten()))
.try_sub(calc_marg(marg.map(|m| m.right.as_ref()).flatten()));
size = size.width(width);
}
size
})
.flex_direction(match props.reverse {
true => FlexDirection::ColumnReverse,
false => FlexDirection::Column,
})
.try_flex_wrap(match (props.wrap, props.reverse_columns) {
(true, true) => Some(Wrap::WrapReverse),
(true, false) => Some(Wrap::Wrap),
_ => None,
})
.try_justify_content(props.align)
.try_align_items(props.cross_align)
.try_align_content(props.align_columns)
.try_align_self(props.align_self)
.try_flex_grow(props.expand_by)
.try_flex_shrink(props.shrink_by)
.try_gap(props.gap.clone())
.try_padding(props.padding.clone())
.try_margin(props.margin.clone());
html! {
<div class="yew-layout-column" style={ style.to_string() }>
{ props.children.clone() }
</div>
}
}
// ======================== Row Component ========================
/// Row properties.
///
/// Here you can find all properties that can be used with [Row](crate::Row)
/// component.
#[derive(Properties, Clone, PartialEq)]
pub struct RowProps {
pub children: Children,
/// Fill the available sapce horizontally.
///
/// The default is `true`
#[prop_or(true)]
pub fill: bool,
/// Fill the available sapce vertically.
///
/// The default is `false`
#[prop_or(false)]
pub cross_fill: bool,
/// Expand factor used to exapnd this row in direction relevant to it's
/// parent layout direction.
///
/// When the parent is `Row` it will expand horizontally, when the parent is
/// `Column` it will expand vertically.
///
/// Note: This only works when this `Row` inside another flex layout.
///
/// The default is `None`
#[prop_or_default]
pub expand_by: Option<f32>,
/// Shrink factor used to shrink this row in direction relevant to it's
/// parent layout direction when needed.
///
/// When the parent is `Row` it will shrink horizontally, when the parent is
/// `Column` it will shrink vertically.
///
/// Note: This only works when this `Row` inside another flex layout.
///
/// The default is `None`
#[prop_or_default]
pub shrink_by: Option<f32>,
/// Make this layout inline
///
/// The default is `false`
#[prop_or(false)]
pub inline: bool,
/// Reverse the order of the children
///
/// The default is `false`
#[prop_or(false)]
pub reverse: bool,
/// Wrap into another row when there is no more horizontal space.
///
/// The default is `false`
#[prop_or(false)]
pub wrap: bool,
/// Align the children inside this row in main direction (vertically).
///
/// The default is `None`
#[prop_or_default]
pub align: Option<Align>,
/// Align the children inside this row in the cross direction
/// (horizontally).
///
/// The default is `None`
#[prop_or_default]
pub cross_align: Option<CrossAlign>,
/// Align this row when it's inside another layout, the alignment direction
/// is relevant to the parent layout direction
///
/// When the parent is `Row` it will align horizontally, when the parent is
/// `Column` it will align vertically.
///
/// Note: This only works when this `Row` inside another layout.
///
/// The default is `None`
#[prop_or_default]
pub align_self: Option<AlignSelf>,
/// Gap between children.
///
/// this take `css_style::Gap` value, which can take either one value that
/// defines the gap for both the columns and rows (if there is any), or two
/// values one for rows and the other for columns.
///
/// The default is `None`
#[prop_or_default]
pub gap: Option<Gap>,
/// Reverse rows if there is more than one column within this `Column`.
///
/// The default is `false`
#[prop_or(false)]
pub reverse_rows: bool,
/// Align rows in the corss direction (vertically) if there is more than one
/// row within this `Row`.
///
/// The default is `None`
#[prop_or_default]
pub align_rows: Option<AlignRows>,
/// Padding for the `Row`
///
/// The default is `None`
#[prop_or_default]
pub padding: Option<Padding>,
/// Margin for the `Row`
///
/// The default is `None`
#[prop_or_default]
pub margin: Option<Margin>,
}
/// Row layout component.
///
/// See [row properties docs](crate::RowProps) for more details on how to use
/// them.
///
/// # Usage
///
/// ```rust
/// use yew_layout::{Row, Align};
/// # use yew::prelude::*;
///
/// # fn view() -> Html {
/// html! {
/// <Row align={ Align::Center } cross_fill=true wrap=true>
/// { "Row children.." }
/// </Row>
/// }
/// # }
/// ```
#[function_component(Row)]
pub fn row(props: &RowProps) -> Html {
let style = Style::default()
.display(match props.inline {
true => Display::InlineFlex,
false => Display::Flex,
})
.and_size(|mut size| {
let calc_pad = |padding: Option<&padding::Length>| {
padding.and_then(|p| Calc::try_from(p.clone()).ok())
};
let calc_marg = |margin: Option<&margin::Length>| {
margin.and_then(|p| Calc::try_from(p.clone()).ok())
};
let pad = props.padding.as_ref();
let marg = props.margin.as_ref();
if props.fill && !props.inline {
let width = calc(percent(1.0))
.try_sub(calc_pad(pad.map(|p| p.left.as_ref()).flatten()))
.try_sub(calc_pad(pad.map(|p| p.right.as_ref()).flatten()))
.try_sub(calc_marg(marg.map(|m| m.left.as_ref()).flatten()))
.try_sub(calc_marg(marg.map(|m| m.right.as_ref()).flatten()));
size = size.width(width);
}
if props.cross_fill && !props.inline {
let height = calc(percent(1.0))
.try_sub(calc_pad(pad.map(|p| p.top.as_ref()).flatten()))
.try_sub(calc_pad(pad.map(|p| p.bottom.as_ref()).flatten()))
.try_sub(calc_marg(marg.map(|m| m.top.as_ref()).flatten()))
.try_sub(calc_marg(marg.map(|m| m.bottom.as_ref()).flatten()));
size = size.height(height);
}
size
})
.flex_direction(match props.reverse {
true => FlexDirection::RowReverse,
false => FlexDirection::Row,
})
.try_flex_wrap(match (props.wrap, props.reverse_rows) {
(true, true) => Some(Wrap::WrapReverse),
(true, false) => Some(Wrap::Wrap),
_ => None,
})
.try_justify_content(props.align)
.try_align_items(props.cross_align)
.try_align_content(props.align_rows)
.try_align_self(props.align_self)
.try_flex_grow(props.expand_by)
.try_flex_shrink(props.shrink_by)
.try_gap(props.gap.clone())
.try_padding(props.padding.clone())
.try_margin(props.margin.clone());
html! {
<div class="yew-layout-row" style={ style.to_string() }>
{ props.children.clone() }
</div>
}
}
