summaryrefslogtreecommitdiffstats
path: root/WebContent/VAADIN/themes/valo/components/_checkbox.scss
diff options
context:
space:
mode:
authorJouni Koivuviita <jouni@vaadin.com>2014-08-29 13:57:46 +0300
committerVaadin Code Review <review@vaadin.com>2014-08-30 08:09:22 +0000
commiteac8c5a24f0bb93139a53aebd19ee91ed4ac4d16 (patch)
treea40db580360c7ae09516ab5711772559f10f62a2 /WebContent/VAADIN/themes/valo/components/_checkbox.scss
parentf50b07abc784ae54af4ce7609d49013319eca57a (diff)
downloadvaadin-framework-eac8c5a24f0bb93139a53aebd19ee91ed4ac4d16.tar.gz
vaadin-framework-eac8c5a24f0bb93139a53aebd19ee91ed4ac4d16.zip
First batch of Valo Sass API documentation, plus bug fixes
Also updates the test to always scroll the left panel to the top after opening a section. Change-Id: Icdb42795b8ec347b91694c162898f41aa8d80152
Diffstat (limited to 'WebContent/VAADIN/themes/valo/components/_checkbox.scss')
-rw-r--r--WebContent/VAADIN/themes/valo/components/_checkbox.scss24
1 files changed, 23 insertions, 1 deletions
diff --git a/WebContent/VAADIN/themes/valo/components/_checkbox.scss b/WebContent/VAADIN/themes/valo/components/_checkbox.scss
index 9fe360c6ed..7ad08ad74d 100644
--- a/WebContent/VAADIN/themes/valo/components/_checkbox.scss
+++ b/WebContent/VAADIN/themes/valo/components/_checkbox.scss
@@ -1,3 +1,11 @@
+/**
+ * Outputs the selectors and properties for the CheckBox component.
+ *
+ * @param {string} $primary-stylename (v-checkbox) - the primary style name for the selectors
+ * @param {bool} $include-additional-styles - should the mixin output all the different style variations of the component
+ *
+ * @group checkbox
+ */
@mixin valo-checkbox ($primary-stylename: v-checkbox, $include-additional-styles: contains($v-included-additional-styles, checkbox)) {
.#{$primary-stylename} {
@@ -20,12 +28,26 @@
}
+/**
+ * Outputs the font icon to indicate the checked state.
+ *
+ * @group checkbox
+ */
@mixin valo-checkbox-icon-style {
content: "\f00c";
font-family: FontAwesome;
}
+/**
+ * Outputs the styles for a checkbox variant.
+ *
+ * @param {color} $background-color ($v-background-color) - The background color of the checkbox
+ * @param {size} $unit-size ($v-unit-size) - The sizing of the checkbox. The width and height of the checkbox will be the unit-size divided by 2.
+ * @param {color} $selection-color ($v-selection-color) - The color of the checked state icon
+ *
+ * @group checkbox
+ */
@mixin valo-checkbox-style ($background-color: $v-background-color, $unit-size: $v-unit-size, $selection-color: $v-selection-color) {
// So that we can use the same 'unit-size' for all component sizes
@@ -57,7 +79,7 @@
margin: 0;
&:focus ~ label:before {
- @include valo-button-focus-style($background-color: $background-color, $border-fallback: null, $include-box-shadow: false);
+ @include valo-button-focus-style($background-color: $background-color, $border-fallback: null);
@include box-shadow(valo-bevel-and-shadow($background-color: $background-color, $bevel: $v-bevel, $shadow: $v-shadow, $gradient: $v-gradient, $include-focus: true));
}