vizia_core 0.4.0

Core components of vizia
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

use super::internal;
use crate::prelude::*;

/// Modifiers for changing the accessibility properties of a view.
pub trait AccessibilityModifiers: internal::Modifiable {
    /// Sets the accessibility role of the view.
    fn role(mut self, role: Role) -> Self {
        let id = self.entity();

        self.context().style.role.insert(id, role);

        self.context().style.needs_access_update(id);

        self
    }

    /// Sets the accessibility name of the view.
    fn name<U: ToStringLocalized>(mut self, name: impl Res<U>) -> Self {
        let entity = self.entity();
        let current = self.current();
        self.context().with_current(current, move |cx| {
            name.set_or_bind(cx, move |cx, name| {
                cx.style.name.insert(entity, name.get_value(cx).to_string_local(cx));
                cx.style.needs_access_update(entity);
            });
        });

        self
    }

    /// Sets the accessibility label relationship for the view using the ID of another view.
    fn labeled_by(mut self, id: impl Into<String>) -> Self {
        let entity = self.entity();
        let id = id.into();

        self.context().style.labelled_by.insert(entity, id);
        self.context().style.needs_access_update(entity);

        self
    }

    /// Sets the accessibility description relationship for the view using the ID of another view.
    fn described_by(mut self, id: impl Into<String>) -> Self {
        let entity = self.entity();
        let id = id.into();

        self.context().style.described_by.insert(entity, id);
        self.context().style.needs_access_update(entity);

        self
    }

    /// Sets the accessibility controls relationship for the view using the ID of another view.
    fn controls(mut self, id: impl Into<String>) -> Self {
        let entity = self.entity();
        let id = id.into();

        self.context().style.controls.insert(entity, id);
        self.context().style.needs_access_update(entity);

        self
    }

    /// Sets the accessibility active descendant relationship for the view.
    fn active_descendant<U: Into<String> + Clone + 'static>(
        mut self,
        id: impl Res<U> + 'static,
    ) -> Self {
        let entity = self.entity();
        let current = self.current();
        self.context().with_current(current, |cx| {
            id.set_or_bind(cx, move |cx, id| {
                cx.style.active_descendant.insert(entity, id.get_value(cx).into());
                cx.style.needs_access_update(entity);
            });
        });

        self
    }

    // /// Sets the accessibility default action for the view.
    // fn default_action_verb(mut self, action_verb: DefaultActionVerb) -> Self {
    //     let id = self.entity();

    //     self.context().style.default_action_verb.insert(id, action_verb);
    //     self.context().style.needs_access_update(id);

    //     self
    // }

    /// Sets whether the view should act as an accessibility live region.
    fn live(mut self, live: Live) -> Self {
        let id = self.entity();

        self.context().style.live.insert(id, live);
        self.context().style.needs_access_update(id);

        self
    }

    /// Sets whether the view should be hidden from accessibility.
    fn hidden<U: Into<bool>>(mut self, hidden: impl Res<U>) -> Self {
        let entity = self.entity();
        let current = self.current();
        self.context().with_current(current, |cx| {
            hidden.set_or_bind(cx, move |cx, hidden| {
                cx.style.hidden.insert(entity, hidden.get_value(cx).into());
                cx.style.needs_access_update(entity);
            });
        });

        self
    }

    /// Sets whether the view should be announced as expanded (`true`) or collapsed (`false`).
    fn expanded<U: Into<bool>>(mut self, expanded: impl Res<U>) -> Self {
        let entity = self.entity();
        let current = self.current();
        self.context().with_current(current, |cx| {
            expanded.set_or_bind(cx, move |cx, expanded| {
                cx.style.expanded.insert(entity, expanded.get_value(cx).into());
                cx.style.needs_access_update(entity);
            });
        });

        self
    }

    /// Sets whether the view should be announced as selected (`true`) or not selected (`false`).
    fn selected<U: Into<bool>>(mut self, selected: impl Res<U>) -> Self {
        let entity = self.entity();
        let current = self.current();
        self.context().with_current(current, |cx| {
            selected.set_or_bind(cx, move |cx, selected| {
                cx.style.selected.insert(entity, selected.get_value(cx).into());
                cx.style.needs_access_update(entity);
            });
        });

        self
    }

    /// Sets the accessibility orientation of the view.
    /// This does not affect the layout of the view, but is used to inform
    /// assistive technologies of the orientation of the view.
    fn orientation<U: Into<Orientation>>(mut self, orientation: impl Res<U>) -> Self {
        let entity = self.entity();
        let current = self.current();
        self.context().with_current(current, |cx| {
            orientation.set_or_bind(cx, move |cx, orientation| {
                let orientation_value = orientation.get_value(cx).into();

                if orientation_value == Orientation::Horizontal {
                    cx.with_current(entity, |cx| {
                        cx.toggle_class("horizontal", true);
                        cx.toggle_class("vertical", false);
                    });
                } else {
                    cx.with_current(entity, |cx| {
                        cx.toggle_class("horizontal", false);
                        cx.toggle_class("vertical", true);
                    });
                }
                cx.style.orientation.insert(entity, orientation_value);
                cx.style.needs_access_update(entity);
            });
        });

        self
    }

    /// Sets the accessibility numeric value for the view.
    fn numeric_value<U: Into<f64>>(mut self, value: impl Res<U>) -> Self {
        let entity = self.entity();
        let current = self.current();
        self.context().with_current(current, |cx| {
            value.set_or_bind(cx, move |cx, val| {
                let v = val.get_value(cx).into();

                cx.style.numeric_value.insert(entity, v);
                cx.style.needs_access_update(entity);
            });
        });

        self
    }

    /// Sets the accessibility text value for the view.
    fn text_value<U: ToStringLocalized>(mut self, value: impl Res<U>) -> Self {
        let entity = self.entity();
        let current = self.current();
        self.context().with_current(current, move |cx| {
            value.set_or_bind(cx, move |cx, val| {
                cx.style.text_value.insert(entity, val.get_value(cx).to_string_local(cx));
                cx.style.needs_access_update(entity);
            });
        });

        self
    }
}

impl<V: View> AccessibilityModifiers for Handle<'_, V> {}