commit a747bdbd27cdb0a7e7557ed25a7222f0a213419f Author: Henry-Hiles Date: Tue Nov 3 14:46:28 2026 -0500 initial commit diff --git a/.envrc b/.envrc new file mode 100644 index 0000000..3550a30 --- /dev/null +++ b/.envrc @@ -0,0 +1 @@ +use flake diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..6567691 --- /dev/null +++ b/.gitignore @@ -0,0 +1,9 @@ +# Flutter/Dart/Pub related +**/doc/api/ +.dart_tool/ +.flutter-plugins-dependencies +/build/ +/coverage/ + +# Nix +.direnv/ diff --git a/.metadata b/.metadata new file mode 100644 index 0000000..81fb383 --- /dev/null +++ b/.metadata @@ -0,0 +1,10 @@ +# This file tracks properties of this Flutter project. +# Used by Flutter tool to assess capabilities and perform upgrades etc. +# +# This file should be version controlled and should not be manually edited. + +version: + revision: "nixpkgs000000000000000000000000000000000" + channel: "stable" + +project_type: package diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..227f443 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,3 @@ +## 1.0.0 + +Initial release. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..496acdb --- /dev/null +++ b/LICENSE @@ -0,0 +1,675 @@ +# GNU GENERAL PUBLIC LICENSE + +Version 3, 29 June 2007 + +Copyright (C) 2007 Free Software Foundation, Inc. + + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + +## Preamble + +The GNU General Public License is a free, copyleft license for +software and other kinds of works. + +The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom +to share and change all versions of a program--to make sure it remains +free software for all its users. We, the Free Software Foundation, use +the GNU General Public License for most of our software; it applies +also to any other work released this way by its authors. You can apply +it to your programs, too. + +When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + +To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you +have certain responsibilities if you distribute copies of the +software, or if you modify it: responsibilities to respect the freedom +of others. + +For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + +Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + +For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + +Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the +manufacturer can do so. This is fundamentally incompatible with the +aim of protecting users' freedom to change the software. The +systematic pattern of such abuse occurs in the area of products for +individuals to use, which is precisely where it is most unacceptable. +Therefore, we have designed this version of the GPL to prohibit the +practice for those products. If such problems arise substantially in +other domains, we stand ready to extend this provision to those +domains in future versions of the GPL, as needed to protect the +freedom of users. + +Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish +to avoid the special danger that patents applied to a free program +could make it effectively proprietary. To prevent this, the GPL +assures that patents cannot be used to render the program non-free. + +The precise terms and conditions for copying, distribution and +modification follow. + +## TERMS AND CONDITIONS + +### 0. Definitions. + +"This License" refers to version 3 of the GNU General Public License. + +"Copyright" also means copyright-like laws that apply to other kinds +of works, such as semiconductor masks. + +"The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + +To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of +an exact copy. The resulting work is called a "modified version" of +the earlier work or a work "based on" the earlier work. + +A "covered work" means either the unmodified Program or a work based +on the Program. + +To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + +To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user +through a computer network, with no transfer of a copy, is not +conveying. + +An interactive user interface displays "Appropriate Legal Notices" to +the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + +### 1. Source Code. + +The "source code" for a work means the preferred form of the work for +making modifications to it. "Object code" means any non-source form of +a work. + +A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + +The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + +The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + +The Corresponding Source need not include anything that users can +regenerate automatically from other parts of the Corresponding Source. + +The Corresponding Source for a work in source code form is that same +work. + +### 2. Basic Permissions. + +All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + +You may make, run and propagate covered works that you do not convey, +without conditions so long as your license otherwise remains in force. +You may convey covered works to others for the sole purpose of having +them make modifications exclusively for you, or provide you with +facilities for running those works, provided that you comply with the +terms of this License in conveying all material for which you do not +control copyright. Those thus making or running the covered works for +you must do so exclusively on your behalf, under your direction and +control, on terms that prohibit them from making any copies of your +copyrighted material outside their relationship with you. + +Conveying under any other circumstances is permitted solely under the +conditions stated below. Sublicensing is not allowed; section 10 makes +it unnecessary. + +### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + +No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + +When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such +circumvention is effected by exercising rights under this License with +respect to the covered work, and you disclaim any intention to limit +operation or modification of the work as a means of enforcing, against +the work's users, your or third parties' legal rights to forbid +circumvention of technological measures. + +### 4. Conveying Verbatim Copies. + +You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + +You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + +### 5. Conveying Modified Source Versions. + +You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these +conditions: + +- a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. +- b) The work must carry prominent notices stating that it is + released under this License and any conditions added under + section 7. This requirement modifies the requirement in section 4 + to "keep intact all notices". +- c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. +- d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + +A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + +### 6. Conveying Non-Source Forms. + +You may convey a covered work in object code form under the terms of +sections 4 and 5, provided that you also convey the machine-readable +Corresponding Source under the terms of this License, in one of these +ways: + +- a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. +- b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the Corresponding + Source from a network server at no charge. +- c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. +- d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. +- e) Convey the object code using peer-to-peer transmission, + provided you inform other peers where the object code and + Corresponding Source of the work are being offered to the general + public at no charge under subsection 6d. + +A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + +A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, +family, or household purposes, or (2) anything designed or sold for +incorporation into a dwelling. In determining whether a product is a +consumer product, doubtful cases shall be resolved in favor of +coverage. For a particular product received by a particular user, +"normally used" refers to a typical or common use of that class of +product, regardless of the status of the particular user or of the way +in which the particular user actually uses, or expects or is expected +to use, the product. A product is a consumer product regardless of +whether the product has substantial commercial, industrial or +non-consumer uses, unless such uses represent the only significant +mode of use of the product. + +"Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to +install and execute modified versions of a covered work in that User +Product from a modified version of its Corresponding Source. The +information must suffice to ensure that the continued functioning of +the modified object code is in no case prevented or interfered with +solely because modification has been made. + +If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + +The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or +updates for a work that has been modified or installed by the +recipient, or for the User Product in which it has been modified or +installed. Access to a network may be denied when the modification +itself materially and adversely affects the operation of the network +or violates the rules and protocols for communication across the +network. + +Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + +### 7. Additional Terms. + +"Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + +Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders +of that material) supplement the terms of this License with terms: + +- a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or +- b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or +- c) Prohibiting misrepresentation of the origin of that material, + or requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or +- d) Limiting the use for publicity purposes of names of licensors + or authors of the material; or +- e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or +- f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions + of it) with contractual assumptions of liability to the recipient, + for any liability that these contractual assumptions directly + impose on those licensors and authors. + +All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + +If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; the +above requirements apply either way. + +### 8. Termination. + +You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + +However, if you cease all violation of this License, then your license +from a particular copyright holder is reinstated (a) provisionally, +unless and until the copyright holder explicitly and finally +terminates your license, and (b) permanently, if the copyright holder +fails to notify you of the violation by some reasonable means prior to +60 days after the cessation. + +Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + +### 9. Acceptance Not Required for Having Copies. + +You are not required to accept this License in order to receive or run +a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + +### 10. Automatic Licensing of Downstream Recipients. + +Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + +An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + +### 11. Patents. + +A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + +A contributor's "essential patent claims" are all patent claims owned +or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + +In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + +If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + +A patent license is "discriminatory" if it does not include within the +scope of its coverage, prohibits the exercise of, or is conditioned on +the non-exercise of one or more of the rights that are specifically +granted under this License. You may not convey a covered work if you +are a party to an arrangement with a third party that is in the +business of distributing software, under which you make payment to the +third party based on the extent of your activity of conveying the +work, and under which the third party grants, to any of the parties +who would receive the covered work from you, a discriminatory patent +license (a) in connection with copies of the covered work conveyed by +you (or copies made from those copies), or (b) primarily for and in +connection with specific products or compilations that contain the +covered work, unless you entered into that arrangement, or that patent +license was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + +### 12. No Surrender of Others' Freedom. + +If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under +this License and any other pertinent obligations, then as a +consequence you may not convey it at all. For example, if you agree to +terms that obligate you to collect a royalty for further conveying +from those to whom you convey the Program, the only way you could +satisfy both those terms and this License would be to refrain entirely +from conveying the Program. + +### 13. Use with the GNU Affero General Public License. + +Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + +### 14. Revised Versions of this License. + +The Free Software Foundation may publish revised and/or new versions +of the GNU General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in +detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies that a certain numbered version of the GNU General Public +License "or any later version" applies to it, you have the option of +following the terms and conditions either of that numbered version or +of any later version published by the Free Software Foundation. If the +Program does not specify a version number of the GNU General Public +License, you may choose any version ever published by the Free +Software Foundation. + +If the Program specifies that a proxy can decide which future versions +of the GNU General Public License can be used, that proxy's public +statement of acceptance of a version permanently authorizes you to +choose that version for the Program. + +Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + +### 15. Disclaimer of Warranty. + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT +WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND +PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE +DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR +CORRECTION. + +### 16. Limitation of Liability. + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR +CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES +ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT +NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR +LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM +TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER +PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +### 17. Interpretation of Sections 15 and 16. + +If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + +END OF TERMS AND CONDITIONS + +## How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these +terms. + +To do so, attach the following notices to the program. It is safest to +attach them to the start of each source file to most effectively state +the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper +mail. + +If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands \`show w' and \`show c' should show the +appropriate parts of the General Public License. Of course, your +program's commands might be different; for a GUI interface, you would +use an "about box". + +You should also get your employer (if you work as a programmer) or +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. For more information on this, and how to apply and follow +the GNU GPL, see . + +The GNU General Public License does not permit incorporating your +program into proprietary programs. If your program is a subroutine +library, you may consider it more useful to permit linking proprietary +applications with the library. If this is what you want to do, use the +GNU Lesser General Public License instead of this License. But first, +please read . diff --git a/README.md b/README.md new file mode 100644 index 0000000..621321b --- /dev/null +++ b/README.md @@ -0,0 +1,103 @@ +Material sheets, menus and popovers that adapt to the window size. On narrow windows they show as bottom sheets, and on wide windows as dialogs, popovers and popup menus. + +## Features + +- `showAdaptiveSheet`: a dialog on desktop, or a bottom sheet on mobile +- `showAdaptivePopover`: a popover anchored to a widget or point on desktop, or a bottom sheet on mobile +- `showAdaptiveMenu`: a popup menu on desktop, or a bottom sheet of the same `PopupMenuEntry`s on mobile +- `AdaptiveMenuButton`: like `PopupMenuButton`, but shows a bottom sheet on mobile +- `SheetLayout`: a title, scrollable content and actions, laid out for both sheets and dialogs +- `AdaptiveBreakpoint`: configure the width where the desktop layout starts + +## Screenshots + +| | Mobile | Desktop | +| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Sheet | ![A bottom sheet asking to delete conversations](https://git.federated.nexus/Henry-Hiles/material_adaptive_sheets/raw/branch/main/assets/screenshots/sheet_mobile.png) | ![A dialog asking to delete conversations](https://git.federated.nexus/Henry-Hiles/material_adaptive_sheets/raw/branch/main/assets/screenshots/sheet_desktop.png) | +| Menu | ![A bottom sheet with menu items](https://git.federated.nexus/Henry-Hiles/material_adaptive_sheets/raw/branch/main/assets/screenshots/menu_mobile.png) | ![A popup menu over the menu button](https://git.federated.nexus/Henry-Hiles/material_adaptive_sheets/raw/branch/main/assets/screenshots/menu_desktop.png) | +| Popover | ![A bottom sheet with inbox details](https://git.federated.nexus/Henry-Hiles/material_adaptive_sheets/raw/branch/main/assets/screenshots/popover_mobile.png) | ![A popover with inbox details below the info button](https://git.federated.nexus/Henry-Hiles/material_adaptive_sheets/raw/branch/main/assets/screenshots/popover_desktop.png) | + + + +## Getting started + +Add the package to your project with `flutter pub add material_adaptive_sheets`. + +## Usage + +All of the `show` methods are extensions on `BuildContext`, and return the value the sheet was closed with. + +### Sheets + +```dart +final confirmed = await context.showAdaptiveSheet( + (context) => SheetLayout( + title: const Text("Delete message?"), + actions: [ + TextButton( + onPressed: () => Navigator.of(context).pop(false), + child: const Text("Cancel"), + ), + FilledButton( + onPressed: () => Navigator.of(context).pop(true), + child: const Text("Delete"), + ), + ], + children: [const Text("This can't be undone.")], + ), +); +``` + +### Menus + +```dart +AdaptiveMenuButton( + icon: const Icon(Icons.more_vert), + itemBuilder: (context) => const [ + PopupMenuItem(value: "edit", child: Text("Edit")), + PopupMenuItem(value: "delete", child: Text("Delete")), + ], + onSelected: (value) => print(value), +); +``` + +Or show a menu at a point, like where the user right clicked: + +```dart +GestureDetector( + onSecondaryTapUp: (details) => context.showAdaptiveMenu( + items, + globalPosition: details.globalPosition, + ), + child: child, +); +``` + +### Popovers + +```dart +IconButton( + icon: const Icon(Icons.info), + onPressed: () => context.showAdaptivePopover( + (context) => const Padding( + padding: EdgeInsets.all(16), + child: Text("Some details"), + ), + ), +); +``` + +On desktop, the popover opens below the widget the context belongs to, or above it if there isn't room. Pass `anchor` to open it somewhere else, such as `context.globalRectAt(details.globalPosition)`. + +### Breakpoint + +By default, the desktop layout is used for windows wider than 650 logical pixels. To change this, wrap your app in an `AdaptiveBreakpoint`: + +```dart +AdaptiveBreakpoint( + width: 800, + child: MaterialApp(...), +); +``` + +`context.isDesktop` is also exported, so the rest of your layout can use the same breakpoint. diff --git a/analysis_options.yaml b/analysis_options.yaml new file mode 100644 index 0000000..5a75ced --- /dev/null +++ b/analysis_options.yaml @@ -0,0 +1,18 @@ +include: package:flutter_lints/flutter.yaml + +analyzer: + errors: + avoid_print: ignore + exclude: + - "build/**" + - "**/*.g.dart" + - "**/*.freezed.dart" + - android/** + - ios/** + - web/** + - windows/** + - macos/** + - linux/** + +# Additional information about this file can be found at +# https://dart.dev/guides/language/analysis-options diff --git a/assets/screenshots/menu_desktop.png b/assets/screenshots/menu_desktop.png new file mode 100644 index 0000000..753bb4b Binary files /dev/null and b/assets/screenshots/menu_desktop.png differ diff --git a/assets/screenshots/menu_mobile.png b/assets/screenshots/menu_mobile.png new file mode 100644 index 0000000..e65a72b Binary files /dev/null and b/assets/screenshots/menu_mobile.png differ diff --git a/assets/screenshots/popover_desktop.png b/assets/screenshots/popover_desktop.png new file mode 100644 index 0000000..e4b5ea1 Binary files /dev/null and b/assets/screenshots/popover_desktop.png differ diff --git a/assets/screenshots/popover_mobile.png b/assets/screenshots/popover_mobile.png new file mode 100644 index 0000000..9b81a39 Binary files /dev/null and b/assets/screenshots/popover_mobile.png differ diff --git a/assets/screenshots/sheet_desktop.png b/assets/screenshots/sheet_desktop.png new file mode 100644 index 0000000..fec471d Binary files /dev/null and b/assets/screenshots/sheet_desktop.png differ diff --git a/assets/screenshots/sheet_mobile.png b/assets/screenshots/sheet_mobile.png new file mode 100644 index 0000000..e367e4d Binary files /dev/null and b/assets/screenshots/sheet_mobile.png differ diff --git a/flake.lock b/flake.lock new file mode 100644 index 0000000..066f38b --- /dev/null +++ b/flake.lock @@ -0,0 +1,130 @@ +{ + "nodes": { + "flake-parts": { + "inputs": { + "nixpkgs-lib": "nixpkgs-lib" + }, + "locked": { + "lastModified": 1788450739, + "narHash": "sha256-glZLQlzIn1fXH6PazR2iUmTo7kzzyYSshrWhLS9TqCU=", + "owner": "hercules-ci", + "repo": "flake-parts", + "rev": "31729ca8cbdb4fa927b34e5f4353e6a83f39e993", + "type": "github" + }, + "original": { + "owner": "hercules-ci", + "repo": "flake-parts", + "type": "github" + } + }, + "flake-utils": { + "inputs": { + "systems": "systems" + }, + "locked": { + "lastModified": 1731533236, + "narHash": "sha256-l0KFg5HjrsfsO/JpG+r7fRrqm12kzFHyUHqHCVpMMbI=", + "owner": "numtide", + "repo": "flake-utils", + "rev": "11707dc2f618dd54ca8739b309ec4fc024de578b", + "type": "github" + }, + "original": { + "owner": "numtide", + "repo": "flake-utils", + "type": "github" + } + }, + "nix2flatpak": { + "inputs": { + "flake-utils": "flake-utils", + "nixpkgs": "nixpkgs" + }, + "locked": { + "lastModified": 1791751882, + "narHash": "sha256-DWcMlQFQMEqQGAHU6rAbl4uKWmlJMR1HZG0BvH0H2fk=", + "owner": "neobrain", + "repo": "nix2flatpak", + "rev": "7731e8b3fca73879f8217de5a919c0a5d17303de", + "type": "github" + }, + "original": { + "owner": "neobrain", + "repo": "nix2flatpak", + "type": "github" + } + }, + "nixpkgs": { + "locked": { + "lastModified": 1773389992, + "narHash": "sha256-wvfdLLWJ2I9oEpDd9PfMA8osfIZicoQ5MT1jIwNs9Tk=", + "owner": "NixOS", + "repo": "nixpkgs", + "rev": "c06b4ae3d6599a672a6210b7021d699c351eebda", + "type": "github" + }, + "original": { + "owner": "NixOS", + "ref": "nixos-unstable", + "repo": "nixpkgs", + "type": "github" + } + }, + "nixpkgs-lib": { + "locked": { + "lastModified": 1788057806, + "narHash": "sha256-DTQSMxzDWmT0zhguthvegnVkn7CFqGCv4IHCzk5ZUpM=", + "owner": "nix-community", + "repo": "nixpkgs.lib", + "rev": "596e2e3940e09b2abbeb03f75fa1828c57fcd72c", + "type": "github" + }, + "original": { + "owner": "nix-community", + "repo": "nixpkgs.lib", + "type": "github" + } + }, + "nixpkgs_2": { + "locked": { + "lastModified": 1790689126, + "narHash": "sha256-ilerN1WLSvF+HMjziC/Wv99J5y02maDH+6hZPwsORKg=", + "owner": "nixos", + "repo": "nixpkgs", + "rev": "b4fd65b198c599cbe814fcb9f42d25d021595ec9", + "type": "github" + }, + "original": { + "owner": "nixos", + "ref": "nixos-unstable", + "repo": "nixpkgs", + "type": "github" + } + }, + "root": { + "inputs": { + "flake-parts": "flake-parts", + "nix2flatpak": "nix2flatpak", + "nixpkgs": "nixpkgs_2" + } + }, + "systems": { + "locked": { + "lastModified": 1681028828, + "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=", + "owner": "nix-systems", + "repo": "default", + "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e", + "type": "github" + }, + "original": { + "owner": "nix-systems", + "repo": "default", + "type": "github" + } + } + }, + "root": "root", + "version": 7 +} diff --git a/flake.nix b/flake.nix new file mode 100644 index 0000000..e4588e7 --- /dev/null +++ b/flake.nix @@ -0,0 +1,50 @@ +{ + description = "Material Adaptive Sheets Flutter Flake"; + + inputs = { + self.submodules = true; + nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable"; + flake-parts.url = "github:hercules-ci/flake-parts"; + nix2flatpak.url = "github:neobrain/nix2flatpak"; + }; + + outputs = + { + flake-parts, + nixpkgs, + self, + ... + }@inputs: + flake-parts.lib.mkFlake { inherit inputs; } { + systems = [ + "x86_64-linux" + "aarch64-linux" + "aarch64-darwin" + "x86_64-darwin" + ]; + + perSystem = + { + lib, + pkgs, + system, + ... + }: + + { + _module.args.pkgs = import nixpkgs { + inherit system; + config = { + android_sdk.accept_license = true; + allowUnfree = true; + }; + }; + + devShells.default = pkgs.mkShell { + packages = with pkgs; [ + flutter + ]; + }; + }; + }; +} diff --git a/lib/material_adaptive_sheets.dart b/lib/material_adaptive_sheets.dart new file mode 100644 index 0000000..bbf2d33 --- /dev/null +++ b/lib/material_adaptive_sheets.dart @@ -0,0 +1,10 @@ +export "src/extensions/global_rect.dart"; +export "src/extensions/is_desktop.dart"; +export "src/extensions/show_adaptive_menu.dart"; +export "src/extensions/show_adaptive_popover.dart"; +export "src/extensions/show_adaptive_sheet.dart"; + +export "src/widgets/adaptive_breakpoint.dart"; +export "src/widgets/adaptive_menu_button.dart"; +export "src/widgets/popover_layout.dart"; +export "src/widgets/sheet_layout.dart"; diff --git a/lib/src/extensions/global_rect.dart b/lib/src/extensions/global_rect.dart new file mode 100644 index 0000000..4f2169f --- /dev/null +++ b/lib/src/extensions/global_rect.dart @@ -0,0 +1,23 @@ +import "package:material_ui/material_ui.dart"; + +extension GlobalRect on BuildContext { + /// Where the widget this context belongs to is on screen, e.g. to open a + /// menu or popover next to it. + Rect get globalRect { + final overlay = Overlay.of(this).context.findRenderObject() as RenderBox; + + return switch (findRenderObject()) { + final RenderBox box => + box.localToGlobal(.zero, ancestor: overlay) & box.size, + _ => Rect.zero, + }; + } + + /// [position] on screen as an empty rect, like where text was tapped, to + /// open a popover there. + Rect globalRectAt(Offset position) { + final overlay = Overlay.of(this).context.findRenderObject() as RenderBox; + + return overlay.globalToLocal(position) & .zero; + } +} diff --git a/lib/src/extensions/is_desktop.dart b/lib/src/extensions/is_desktop.dart new file mode 100644 index 0000000..971483a --- /dev/null +++ b/lib/src/extensions/is_desktop.dart @@ -0,0 +1,9 @@ +import "package:material_ui/material_ui.dart"; +import "package:material_adaptive_sheets/src/widgets/adaptive_breakpoint.dart"; + +extension IsDesktop on BuildContext { + /// Whether the window is wider than the closest [AdaptiveBreakpoint], so + /// menus and popovers should be used instead of bottom sheets. + bool get isDesktop => + MediaQuery.sizeOf(this).width > AdaptiveBreakpoint.of(this); +} diff --git a/lib/src/extensions/show_adaptive_menu.dart b/lib/src/extensions/show_adaptive_menu.dart new file mode 100644 index 0000000..7d1fd4f --- /dev/null +++ b/lib/src/extensions/show_adaptive_menu.dart @@ -0,0 +1,53 @@ +import "package:material_ui/material_ui.dart"; +import "package:material_adaptive_sheets/src/extensions/global_rect.dart"; +import "package:material_adaptive_sheets/src/extensions/is_desktop.dart"; + +extension ShowAdaptiveMenu on BuildContext { + /// Shows [items] in a popup menu on desktop, or a bottom sheet on mobile. + /// + /// On desktop, the menu opens at [globalPosition] if given (e.g. where the + /// user right clicked), or over the widget this context belongs to. + /// + /// Returns the value of the selected [PopupMenuItem], if any. + Future showAdaptiveMenu( + List> items, { + Offset? globalPosition, + }) { + if (!isDesktop) { + return showModalBottomSheet( + context: this, + isScrollControlled: true, + showDragHandle: true, + builder: (context) => SafeArea( + child: SingleChildScrollView( + padding: const .only(bottom: 8), + // PopupMenuItems must be inside something with the menu role + child: Semantics( + role: .menu, + explicitChildNodes: true, + child: ListTileTheme.merge( + contentPadding: const .symmetric(horizontal: 24), + minTileHeight: 48, + titleTextStyle: Theme.of(context).textTheme.titleMedium, + child: Column(mainAxisSize: .min, children: items), + ), + ), + ), + ), + ); + } + + final overlay = Overlay.of(this).context.findRenderObject() as RenderBox; + final anchor = switch (globalPosition) { + final position? => position & Size.zero, + null => globalRect, + }; + + return showMenu( + context: this, + constraints: .loose(.infinite), + position: .fromRect(anchor, Offset.zero & overlay.size), + items: items, + ); + } +} diff --git a/lib/src/extensions/show_adaptive_popover.dart b/lib/src/extensions/show_adaptive_popover.dart new file mode 100644 index 0000000..a2e4200 --- /dev/null +++ b/lib/src/extensions/show_adaptive_popover.dart @@ -0,0 +1,41 @@ +import "package:material_ui/material_ui.dart"; +import "package:material_adaptive_sheets/src/extensions/global_rect.dart"; +import "package:material_adaptive_sheets/src/extensions/is_desktop.dart"; +import "package:material_adaptive_sheets/src/extensions/show_adaptive_sheet.dart"; +import "package:material_adaptive_sheets/src/widgets/popover_layout.dart"; + +extension ShowAdaptivePopover on BuildContext { + /// Shows the widget from [builder] in a popover next to [anchor], or the + /// widget this context belongs to, on desktop, or a bottom sheet on mobile. + /// Use the context passed to [builder] to close it. + /// + /// [constraints] limits the size of the popover on desktop. + Future showAdaptivePopover( + WidgetBuilder builder, { + Rect? anchor, + BoxConstraints constraints = const .new(maxWidth: 420, maxHeight: 600), + }) { + if (!isDesktop) return showAdaptiveSheet(builder); + + final rect = anchor ?? globalRect; + + return showDialog( + context: this, + barrierColor: Colors.transparent, + useSafeArea: false, + builder: (context) => CustomSingleChildLayout( + delegate: PopoverLayout(rect), + child: ConstrainedBox( + constraints: constraints, + child: Material( + elevation: 8, + clipBehavior: .antiAlias, + color: Theme.of(context).colorScheme.surfaceContainer, + borderRadius: .circular(16), + child: Builder(builder: builder), + ), + ), + ), + ); + } +} diff --git a/lib/src/extensions/show_adaptive_sheet.dart b/lib/src/extensions/show_adaptive_sheet.dart new file mode 100644 index 0000000..a055fa4 --- /dev/null +++ b/lib/src/extensions/show_adaptive_sheet.dart @@ -0,0 +1,38 @@ +import "package:material_ui/material_ui.dart"; +import "package:material_adaptive_sheets/src/extensions/is_desktop.dart"; + +extension ShowAdaptiveSheet on BuildContext { + /// Shows the widget from [builder] in a dialog on desktop, or a bottom sheet + /// on mobile. Use the context passed to [builder] to close it. + /// + /// [dialogConstraints] limits the size of the dialog on desktop. + Future showAdaptiveSheet( + WidgetBuilder builder, { + bool enableDrag = true, + BoxConstraints dialogConstraints = const .new( + maxWidth: 450, + maxHeight: 600, + ), + }) => isDesktop + ? showDialog( + context: this, + builder: (context) => Dialog( + clipBehavior: .antiAlias, + child: ConstrainedBox( + constraints: dialogConstraints, + child: Builder(builder: builder), + ), + ), + ) + : showModalBottomSheet( + context: this, + isScrollControlled: true, + enableDrag: enableDrag, + constraints: .new(maxHeight: MediaQuery.sizeOf(this).height - 80), + // Passing constraints lets the sheet shrink to its content, so + // stretch it to the full width like a sheet without them + builder: (context) => SafeArea( + child: SizedBox(width: .infinity, child: builder(context)), + ), + ); +} diff --git a/lib/src/widgets/adaptive_breakpoint.dart b/lib/src/widgets/adaptive_breakpoint.dart new file mode 100644 index 0000000..de4f13f --- /dev/null +++ b/lib/src/widgets/adaptive_breakpoint.dart @@ -0,0 +1,20 @@ +import "package:material_ui/material_ui.dart"; + +/// Sets the window width above which descendants use the desktop layout, with +/// dialogs, popovers and menus instead of bottom sheets. +class const AdaptiveBreakpoint({ + final double width = defaultWidth, + required super.child, + super.key, +}) extends InheritedWidget { + static const defaultWidth = 650.0; + + /// The [width] of the closest [AdaptiveBreakpoint], or [defaultWidth]. + static double of(BuildContext context) => + context.dependOnInheritedWidgetOfExactType()?.width ?? + defaultWidth; + + @override + bool updateShouldNotify(AdaptiveBreakpoint oldWidget) => + oldWidget.width != width; +} diff --git a/lib/src/widgets/adaptive_menu_button.dart b/lib/src/widgets/adaptive_menu_button.dart new file mode 100644 index 0000000..c1fdd1b --- /dev/null +++ b/lib/src/widgets/adaptive_menu_button.dart @@ -0,0 +1,25 @@ +import "package:material_ui/material_ui.dart"; +import "package:material_adaptive_sheets/src/extensions/show_adaptive_menu.dart"; + +/// Like [PopupMenuButton], but shows a bottom sheet on mobile. +class const AdaptiveMenuButton({ + required final Widget icon, + required final List> Function(BuildContext context) + itemBuilder, + final ValueChanged? onSelected, + final String? tooltip, + final bool enabled = true, + super.key, +}) extends StatelessWidget { + @override + Widget build(BuildContext context) => IconButton( + icon: icon, + tooltip: tooltip, + onPressed: enabled + ? () async { + final value = await context.showAdaptiveMenu(itemBuilder(context)); + if (value is T) onSelected?.call(value); + } + : null, + ); +} diff --git a/lib/src/widgets/popover_layout.dart b/lib/src/widgets/popover_layout.dart new file mode 100644 index 0000000..0ef8ebe --- /dev/null +++ b/lib/src/widgets/popover_layout.dart @@ -0,0 +1,33 @@ +import "dart:math"; + +import "package:material_ui/material_ui.dart"; + +/// Positions a popover below [anchor], or above it if there isn't room below, +/// keeping it fully on screen. +class const PopoverLayout(final Rect anchor) extends SingleChildLayoutDelegate { + static const margin = 8.0; + + @override + BoxConstraints getConstraintsForChild(BoxConstraints constraints) => + constraints.loosen().deflate(const .all(margin)); + + @override + Offset getPositionForChild(Size size, Size childSize) { + final fitsBelow = anchor.bottom + childSize.height + margin <= size.height; + + return .new( + anchor.left.clamp( + margin, + max(margin, size.width - childSize.width - margin), + ), + (fitsBelow ? anchor.bottom : anchor.top - childSize.height).clamp( + margin, + max(margin, size.height - childSize.height - margin), + ), + ); + } + + @override + bool shouldRelayout(PopoverLayout oldDelegate) => + oldDelegate.anchor != anchor; +} diff --git a/lib/src/widgets/sheet_layout.dart b/lib/src/widgets/sheet_layout.dart new file mode 100644 index 0000000..9a15a1d --- /dev/null +++ b/lib/src/widgets/sheet_layout.dart @@ -0,0 +1,42 @@ +import "package:material_ui/material_ui.dart"; + +class const SheetLayout({ + final Widget? title, + required final List children, + required final List actions, + super.key, +}) extends StatelessWidget { + @override + Widget build(BuildContext context) => Padding( + padding: .only(bottom: MediaQuery.viewInsetsOf(context).bottom), + child: Column( + mainAxisSize: .min, + crossAxisAlignment: .stretch, + children: [ + if (title case final title?) + Padding( + padding: const .fromLTRB(24, 24, 24, 0), + child: DefaultTextStyle( + style: Theme.of(context).textTheme.headlineSmall!, + child: title, + ), + ), + Flexible( + child: SingleChildScrollView( + padding: .fromLTRB(24, title == null ? 24 : 12, 24, 12), + child: Column( + mainAxisSize: .min, + crossAxisAlignment: .stretch, + spacing: 12, + children: children, + ), + ), + ), + Padding( + padding: const .fromLTRB(24, 0, 24, 24), + child: Row(mainAxisAlignment: .end, spacing: 8, children: actions), + ), + ], + ), + ); +} diff --git a/pubspec.lock b/pubspec.lock new file mode 100644 index 0000000..8b06e4b --- /dev/null +++ b/pubspec.lock @@ -0,0 +1,234 @@ +# Generated by pub +# See https://dart.dev/tools/pub/glossary#lockfile +packages: + async: + dependency: transitive + description: + name: async + sha256: e2eb0491ba5ddb6177742d2da23904574082139b07c1e33b8503b9f46f3e1a37 + url: "https://pub.dev" + source: hosted + version: "2.13.1" + boolean_selector: + dependency: transitive + description: + name: boolean_selector + sha256: "8aab1771e1243a5063b8b0ff68042d67334e3feab9e95b9490f9a6ebf73b42ea" + url: "https://pub.dev" + source: hosted + version: "2.1.2" + characters: + dependency: transitive + description: + name: characters + sha256: faf38497bda5ead2a8c7615f4f7939df04333478bf32e4173fcb06d428b5716b + url: "https://pub.dev" + source: hosted + version: "1.4.1" + clock: + dependency: transitive + description: + name: clock + sha256: e51d50bca3217c9a9fa2b41a30e4a38971133f5f9ec7a3d57bae095007f1d28e + url: "https://pub.dev" + source: hosted + version: "1.1.3" + collection: + dependency: transitive + description: + name: collection + sha256: "2f5709ae4d3d59dd8f7cd309b4e023046b57d8a6c82130785d2b0e5868084e76" + url: "https://pub.dev" + source: hosted + version: "1.19.1" + cupertino_ui: + dependency: transitive + description: + name: cupertino_ui + sha256: e003b87afde18cb396ec15928c7894063d64af04462c68df9a1404c461316dd2 + url: "https://pub.dev" + source: hosted + version: "1.1.5" + fake_async: + dependency: transitive + description: + name: fake_async + sha256: "5368f224a74523e8d2e7399ea1638b37aecfca824a3cc4dfdf77bf1fa905ac44" + url: "https://pub.dev" + source: hosted + version: "1.3.3" + flutter: + dependency: "direct main" + description: flutter + source: sdk + version: "0.0.0" + flutter_lints: + dependency: "direct dev" + description: + name: flutter_lints + sha256: "3105dc8492f6183fb076ccf1f351ac3d60564bff92e20bfc4af9cc1651f4e7e1" + url: "https://pub.dev" + source: hosted + version: "6.0.0" + flutter_localizations: + dependency: transitive + description: flutter + source: sdk + version: "0.0.0" + flutter_test: + dependency: "direct dev" + description: flutter + source: sdk + version: "0.0.0" + intl: + dependency: transitive + description: + name: intl + sha256: "1ca20c894b1717686a2319b8548763d812bc0aabdac580420a44c5178c57a867" + url: "https://pub.dev" + source: hosted + version: "0.20.3" + leak_tracker: + dependency: transitive + description: + name: leak_tracker + sha256: "33e2e26bdd85a0112ec15400c8cbffea70d0f9c3407491f672a2fad47915e2de" + url: "https://pub.dev" + source: hosted + version: "11.0.2" + leak_tracker_flutter_testing: + dependency: transitive + description: + name: leak_tracker_flutter_testing + sha256: "1dbc140bb5a23c75ea9c4811222756104fbcd1a27173f0c34ca01e16bea473c1" + url: "https://pub.dev" + source: hosted + version: "3.0.10" + leak_tracker_testing: + dependency: transitive + description: + name: leak_tracker_testing + sha256: "8d5a2d49f4a66b49744b23b018848400d23e54caf9463f4eb20df3eb8acb2eb1" + url: "https://pub.dev" + source: hosted + version: "3.0.2" + lints: + dependency: transitive + description: + name: lints + sha256: "12f842a479589fea194fe5c5a3095abc7be0c1f2ddfa9a0e76aed1dbd26a87df" + url: "https://pub.dev" + source: hosted + version: "6.1.0" + matcher: + dependency: transitive + description: + name: matcher + sha256: "31bd099b47c10cd1aeb55146a2d46ce0277630ecef3f7dae54ad7873f36696cd" + url: "https://pub.dev" + source: hosted + version: "0.12.20" + material_color_utilities: + dependency: transitive + description: + name: material_color_utilities + sha256: "9c337007e82b1889149c82ed242ed1cb24a66044e30979c44912381e9be4c48b" + url: "https://pub.dev" + source: hosted + version: "0.13.0" + material_ui: + dependency: "direct main" + description: + name: material_ui + sha256: feb289df1e5f9ed9522f9fe3d909432a7f7bc76943f16abad09f80a16cd25196 + url: "https://pub.dev" + source: hosted + version: "1.9.0" + meta: + dependency: transitive + description: + name: meta + sha256: "307249ce4ff29d58a18e97f6345f539382eb9c9c29ecda628900f31de0443dd9" + url: "https://pub.dev" + source: hosted + version: "1.19.0" + path: + dependency: transitive + description: + name: path + sha256: "75cca69d1490965be98c73ceaea117e8a04dd21217b37b292c9ddbec0d955bc5" + url: "https://pub.dev" + source: hosted + version: "1.9.1" + sky_engine: + dependency: transitive + description: flutter + source: sdk + version: "0.0.0" + source_span: + dependency: transitive + description: + name: source_span + sha256: "56a02f1f4cd1a2d96303c0144c93bd6d909eea6bee6bf5a0e0b685edbd4c47ab" + url: "https://pub.dev" + source: hosted + version: "1.10.2" + stack_trace: + dependency: transitive + description: + name: stack_trace + sha256: "277654b3034d17ac6f9f1cb5595db011b1d5d41e8806866db28e0abaa101c490" + url: "https://pub.dev" + source: hosted + version: "1.12.2" + stream_channel: + dependency: transitive + description: + name: stream_channel + sha256: "969e04c80b8bcdf826f8f16579c7b14d780458bd97f56d107d3950fdbeef059d" + url: "https://pub.dev" + source: hosted + version: "2.1.4" + string_scanner: + dependency: transitive + description: + name: string_scanner + sha256: "921cd31725b72fe181906c6a94d987c78e3b98c2e205b397ea399d4054872b43" + url: "https://pub.dev" + source: hosted + version: "1.4.1" + term_glyph: + dependency: transitive + description: + name: term_glyph + sha256: "7f554798625ea768a7518313e58f83891c7f5024f88e46e7182a4558850a4b8e" + url: "https://pub.dev" + source: hosted + version: "1.2.2" + test_api: + dependency: transitive + description: + name: test_api + sha256: "2a122cbe059f8b610d3a5415f42e255b6c17b1f21eee1d960f31080237fb4f11" + url: "https://pub.dev" + source: hosted + version: "0.7.12" + vector_math: + dependency: transitive + description: + name: vector_math + sha256: fa49e1674cb84acb900141714e6c6e1f9ae099827c24d141430ff6819db4e1bc + url: "https://pub.dev" + source: hosted + version: "2.4.4" + vm_service: + dependency: transitive + description: + name: vm_service + sha256: "89b11d62e1040ee681af3b4f1c97a803ecbf010c6e8b9c5896ee5b08c3bf7b78" + url: "https://pub.dev" + source: hosted + version: "15.4.0" +sdks: + dart: ">=3.13.0 <4.0.0" + flutter: ">=3.47.0" diff --git a/pubspec.yaml b/pubspec.yaml new file mode 100644 index 0000000..05ff98f --- /dev/null +++ b/pubspec.yaml @@ -0,0 +1,18 @@ +name: material_adaptive_sheets +description: Material sheets, menus and popovers that adapt to the window size, showing bottom sheets on mobile and dialogs, popovers and popup menus on desktop +version: 1.0.0 +repository: https://git.federated.nexus/Henry-Hiles/material_adaptive_sheets +issue_tracker: https://git.federated.nexus/Henry-Hiles/material_adaptive_sheets/issues + +environment: + sdk: ^3.13.0 + +dependencies: + flutter: + sdk: flutter + material_ui: ^1.6.0 + +dev_dependencies: + flutter_lints: 6.0.0 + flutter_test: + sdk: flutter diff --git a/test/screenshots_test.dart b/test/screenshots_test.dart new file mode 100644 index 0000000..13485d3 --- /dev/null +++ b/test/screenshots_test.dart @@ -0,0 +1,176 @@ +import "dart:io"; + +import "package:flutter/services.dart"; + +import "package:flutter_test/flutter_test.dart"; +import "package:material_adaptive_sheets/material_adaptive_sheets.dart"; +import "package:material_ui/material_ui.dart"; + +// Renders the README screenshots into assets/screenshots. +// Regenerate them with `flutter test --update-goldens`. + +const mobile = Size(400, 720); +const desktop = Size(900, 600); + +Future loadFonts() async { + final fonts = + "${Platform.environment["FLUTTER_ROOT"]}/bin/cache/artifacts/material_fonts"; + + Future load(String family, List files) async { + final loader = FontLoader(family); + for (final file in files) { + loader.addFont( + File("$fonts/$file") + .readAsBytes() + .then((bytes) => ByteData.sublistView(bytes)), + ); + } + await loader.load(); + } + + await load("Roboto", [ + "Roboto-Regular.ttf", + "Roboto-Medium.ttf", + "Roboto-Bold.ttf", + ]); + await load("MaterialIcons", ["MaterialIcons-Regular.otf"]); +} + +class const Demo({super.key}) extends StatelessWidget { + @override + Widget build(BuildContext context) => Scaffold( + appBar: AppBar( + title: const Text("Inbox"), + actions: [ + Builder( + builder: (context) => IconButton( + key: const Key("popover"), + icon: const Icon(Icons.info_outline), + tooltip: "Details", + onPressed: () => context.showAdaptivePopover( + (context) => const Padding( + padding: .all(16), + child: Column( + mainAxisSize: .min, + crossAxisAlignment: .start, + spacing: 8, + children: [ + Text( + "Inbox", + style: TextStyle(fontSize: 18, fontWeight: .w500), + ), + Text("3 conversations, 1 unread"), + Text("Last synced just now"), + ], + ), + ), + ), + ), + ), + AdaptiveMenuButton( + key: const Key("menu"), + icon: const Icon(Icons.more_vert), + tooltip: "More", + itemBuilder: (context) => const [ + PopupMenuItem( + value: "read", + child: ListTile( + leading: Icon(Icons.done_all), + title: Text("Mark all as read"), + ), + ), + PopupMenuItem( + value: "archive", + child: ListTile( + leading: Icon(Icons.archive_outlined), + title: Text("Archive"), + ), + ), + PopupMenuItem( + value: "settings", + child: ListTile( + leading: Icon(Icons.settings_outlined), + title: Text("Settings"), + ), + ), + ], + ), + ], + ), + body: ListView( + children: [ + for (final (name, message) in const [ + ("Alice", "Are we still on for tomorrow?"), + ("Bob", "Sent you the photos from the trip"), + ("Carol", "Thanks for the help!"), + ]) + ListTile( + leading: CircleAvatar(child: Text(name[0])), + title: Text(name), + subtitle: Text(message), + ), + ], + ), + floatingActionButton: Builder( + builder: (context) => FloatingActionButton( + key: const Key("sheet"), + tooltip: "Delete", + child: const Icon(Icons.delete_outline), + onPressed: () => context.showAdaptiveSheet( + (context) => SheetLayout( + title: const Text("Delete conversations?"), + actions: [ + TextButton( + onPressed: () => Navigator.of(context).pop(), + child: const Text("Cancel"), + ), + FilledButton( + onPressed: () => Navigator.of(context).pop(), + child: const Text("Delete"), + ), + ], + children: const [ + Text( + "All 3 conversations in your inbox will be deleted. This can't be undone.", + ), + ], + ), + ), + ), + ), + ); +} + +void main() { + setUpAll(loadFonts); + + for (final (name, size) in const [("mobile", mobile), ("desktop", desktop)]) { + for (final surface in const ["sheet", "menu", "popover"]) { + testWidgets("$surface on $name", (tester) async { + tester.view + ..physicalSize = size * 2 + ..devicePixelRatio = 2; + addTearDown(tester.view.reset); + // Draw real shadows instead of the outlines used by default in tests + debugDisableShadows = false; + + await tester.pumpWidget( + MaterialApp( + debugShowCheckedModeBanner: false, + theme: ThemeData(colorSchemeSeed: Colors.indigo), + home: const Demo(), + ), + ); + await tester.tap(find.byKey(Key(surface))); + await tester.pumpAndSettle(); + + await expectLater( + find.byType(MaterialApp), + matchesGoldenFile("../assets/screenshots/${surface}_$name.png"), + ); + + debugDisableShadows = true; + }); + } + } +}