Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

KCheckbox: Remove local state management, rely on given props #744

Merged
merged 2 commits into from
Sep 3, 2024
Merged

KCheckbox: Remove local state management, rely on given props #744

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
325a8ca
KCheckbox: Remove local state management, rely on given props
nucleogenesis Aug 29, 2024
49aaebe
kcheckbox docs updated to use props rather than rely on internal state
nucleogenesis Sep 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 34 additions & 6 deletions docs/pages/kcheckbox.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,13 @@
<DocsShow>
<KCheckbox
label="Some label"
:checked="true"
:checked="checked1"
@change="checked1 = !checked1"
/>
<KCheckbox
label="Another label"
:checked="false"
:checked="checked2"
@change="checked2 = !checked2"
/>
</DocsShow>
</DocsPageSection>
Expand Down Expand Up @@ -39,7 +41,9 @@
<DocsShow>
<KCheckbox
label="Topic is selected"
:indeterminate="true"
:indeterminate="indeterminate3"
:checked="checked3"
@change="handle3"
/>
</DocsShow>
<p>
Expand All @@ -53,11 +57,11 @@
<!-- eslint-disable -->
<!-- prevent prettier from changing indentation -->
<DocsShowCode language="html">
<KCheckbox label="First lesson" />;
<KCheckbox label="First lesson" />
</DocsShowCode>
<!-- eslint-enable -->
<DocsShow>
<KCheckbox label="First lesson" />
<KCheckbox label="First lesson" :checked="checked4" @change="checked4 = !checked4" />
</DocsShow>

In more complex situations, for example when another component is responsible for rendering the label, the default slot can be used:
Expand All @@ -71,7 +75,7 @@
</DocsShowCode>
<!-- eslint-enable -->
<DocsShow>
<KCheckbox>
<KCheckbox :checked="checked5" @change="checked5 = !checked5">
<KLabeledIcon icon="lesson" label="First lesson" />
</KCheckbox>
</DocsShow>
Expand All @@ -97,3 +101,27 @@
</DocsPageTemplate>

</template>


<script>
export default {
data() {
return {
checked1: true,
checked2: false,
checked3: false,
indeterminate3: true,
checked4: false,
checked5: false,
};
},
methods: {
handle3() {
this.checked3 = !this.checked3;
this.indeterminate3 = false;
},
},
};
</script>
28 changes: 6 additions & 22 deletions lib/KCheckbox.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@
type="checkbox"
class="k-checkbox-input"
:aria-checked="ariaChecked"
:checked="isCurrentlyChecked"
:indeterminate.prop="isCurrentlyIndeterminate"
:checked="checked"
:indeterminate.prop="indeterminate"
:disabled="disabled"
@click.stop="toggleCheck"
@focus="isActive = true"
Expand All @@ -24,13 +24,13 @@
>

<KIcon
v-if="isCurrentlyIndeterminate"
v-if="indeterminate"
:style="notBlank"
class="checkbox-icon"
icon="indeterminateCheck"
/>
<KIcon
v-else-if="!isCurrentlyIndeterminate && isCurrentlyChecked"
v-else-if="!indeterminate && checked"
:style="[ notBlank, activeOutline ]"
class="checkbox-icon"
icon="checked"
Expand Down Expand Up @@ -122,13 +122,11 @@
},
},
data: () => ({
isCurrentlyChecked: false,
isCurrentlyIndeterminate: false,
isActive: false,
}),
computed: {
ariaChecked() {
return this.isCurrentlyIndeterminate ? 'mixed' : this.isCurrentlyChecked ? 'true' : 'false';
return this.indeterminate ? 'mixed' : this.checked ? 'true' : 'false';
},
id() {
return `k-checkbox-${this._uid}`;
Expand All @@ -152,28 +150,14 @@
};
},
},
watch: {
checked(newCheckedState) {
this.isCurrentlyChecked = newCheckedState;
},
indeterminate(newIndeterminateState) {
this.isCurrentlyIndeterminate = newIndeterminateState;
},
},
created() {
this.isCurrentlyChecked = this.checked;
this.isCurrentlyIndeterminate = this.indeterminate;
},
methods: {
toggleCheck(event) {
if (!this.disabled) {
this.isCurrentlyChecked = !this.isCurrentlyChecked;
this.$refs.kCheckboxInput.focus();
this.isCurrentlyIndeterminate = false;
/**
* Emits change event
*/
this.$emit('change', this.isCurrentlyChecked, event);
this.$emit('change', !this.checked, event);
}
},
markInactive() {
Expand Down